Split into per language readme#17
Merged
Merged
Conversation
johnpmitsch
changed the title
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
1 participant
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.
Note
Low Risk
Documentation and package-metadata updates only; main risk is publishing/rendering the wrong README on crates.io/PyPI/npm due to manifest wiring changes.
Overview
Moves the large, multi-language API documentation out of the root
README.mdand into per-language package READMEs, leaving the root README focused on project structure, development, and release processes.Adds new per-language docs (
crates/core/README.md,npm/README.md) and updates package metadata to ensure each registry renders the correct README (coreCargo.tomlreadme,pyproject.tomlreadme, and npmpackage.jsonfiles). UpdatesCLAUDE.mdwith explicit rules for keeping all five READMEs consistent and correctly wired into manifests.Reviewed by Cursor Bugbot for commit bf29267. Bugbot is set up for automated code reviews on this repo. Configure here.