Repository navigation
docs: Update readme - #17
Merged
Merged
Conversation
Move the repository layout and both Releasing sections (npm and PyPI) out of the READMEs into a new CONTRIBUTING.md, so the READMEs contain only what end users need. Remove the "Design notes: the routes considered" section from the Python README entirely. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GBC1e1Qg9riYsPnDoPkHdz
Keep the README purely user-oriented; CONTRIBUTING.md is discoverable on its own. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GBC1e1Qg9riYsPnDoPkHdz
Patch releases carrying the updated, user-only READMEs. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GBC1e1Qg9riYsPnDoPkHdz
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
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.
Move developer-related README to CONTRIBUTING.md