docs: move package docs to per-package READMEs#27
Merged
Conversation
Each published package now has its own README.md at the package root so it surfaces on npmjs.com and renders inline when browsing the package folder on GitHub. Removes the duplicated docs/packages/ folder and updates the root README cross-references.
GitHub's README discovery picks .github/README.md over the root README.md. Removing the .github stub so the repo home page renders the canonical landing at the root.
4 tasks
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.
Summary
Follow-up to #26. Two cleanups so the right README shows up where readers expect it.
1. Per-package READMEs
Move the per-package reference docs out of
docs/packages/and into each package's ownREADME.mdso they:README.mdfrom the package root).Each package README is rewritten as a landing-style doc with install snippet and a minimal quickstart, then links back to the monorepo
docs/for overview, glossary, flows, and ADRs.2. Remove
.github/README.mdGitHub's README discovery picks
.github/README.mdover the rootREADME.md(confirmed viaGET /repos/.../readme). The stub at.github/README.mdwas outdated and was hiding the new root landing. Removed so the repo home page renders the canonical README at the root.Changes
packages/protocol-core/README.md(64 lines)packages/sdk/README.md(70 lines)docs/packages/protocol-core.md,docs/packages/sdk.md(folder gone).github/README.mdREADME.md: package-table links now point atpackages/<name>/, and the docs index links to the in-page Packages sectionTest plan
packages/protocol-core/andpackages/sdk/on GitHub — the README renders inlineREADME.md— every link resolves (nodocs/packages/404s).github/README.md)