Reorganize the Readme Files #213
Closed
+132
−108
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
…ake a small readme for twirp-build that links to the twirp readme
There was a problem hiding this comment.
Pull Request Overview
This PR reorganizes the README structure by making the twirp crate README the primary documentation and creating a symlink from the repository root. The changes simplify the documentation hierarchy and redirect users to the main twirp crate for comprehensive usage information.
- Moved comprehensive documentation from
twirp-buildtotwirpcrate README - Created a simplified
twirp-buildREADME that references the main documentation - Replaced root README with a symlink to the
twirpcrate README
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| crates/twirp/README.md | Expanded from brief description to comprehensive documentation with usage examples |
| crates/twirp-build/README.md | Simplified to basic description with reference to main documentation |
| README.md | Replaced with symlink content pointing to twirp crate README |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
twirpcrate readme the main readmetwirpcrate readme from repo root - the PR diff view does not make it clear thatREADME.mdsymlinks tocrates/twirp/README.mdtwirp-buildthat links to thetwirpreadmeThis change stems from a conversation with @tclem