docs: Documentation and Testing Improvements fixing #387 #392
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
NiKrause
changed the title
NiKrause
changed the title
Member
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
README Overhaul
• Rewrote the README with a focus on consuming UCAN services rather than building them
• Updated example code using latest api
• Structured content: basic usage → delegations → batch operations → advanced patterns
• Added live code links to test files for every example, making docs verifiable
• Enhanced packages/server/README.md with detailed server implementation examples
Test Coverage
• Added new integration tests in packages/server/test/readme-integration.spec.js
• Added new example tests in packages/server/test/readme-examples.spec.js
• All README examples are now automatically tested
• Tests use the recommended server-as-channel pattern
CI/CD Infrastructure
• Added Playwright setup to all GitHub Actions workflows
• Added test status badges for all packages (Core, Principal, Transport, Interface, Server, Client, Validator)
• Improved TypeScript configuration in packages/server/tsconfig.json
• Fixed various test issues and type checking problems
• Updated badge URLs