docs: mirror package README to repo root for GitHub home page#16
Merged
Conversation
GitHub only renders a root README.md on the repository home page, so the polished package README (also published to npm) is now mirrored verbatim to the root. Since package/README.md uses absolute URLs throughout, the two files are byte-identical and the mirror is a plain copy. - scripts/sync-readme.mjs: copy package -> root, with --check for CI - package.json: sync:readme / check:readme scripts - ts-checks: fail CI if the root README is out of sync - rule-readme-sync: regenerate root via npm run sync:readme, never hand-edit Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
What
GitHub only renders a root
README.mdon the repository home page, so the polished package README (also published to npm) is now mirrored verbatim to the root.Since
package/README.mduses absolute URLs throughout (badges, banner, screenshots, links toAGENTS.md/CLAUDE.md/LICENSE), the two files are byte-identical and the mirror is a plain copy — no path rewriting.Changes
README.md(root) — now a verbatim mirror ofpackage/README.mdscripts/sync-readme.mjs— copies package → root;--checkfails if out of syncpackage.json—sync:readme/check:readmescriptsts-checks— CI step fails if the root README is stale.claude/rules/rule-readme-sync.md— regenerate vianpm run sync:readme, never hand-edit root🤖 Generated with Claude Code