Merged
Conversation
Root README is the GitHub landing page and should contain the full API documentation. packages/kit/README.md (shown on npm) now points to GitHub for docs. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Root README.md has the full docs. At publish time, prepublishOnly copies it into packages/kit/ for npm. The copy is gitignored. Co-Authored-By: Claude Opus 4.6 <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.
Summary
README.mdis the single source of truth for all documentation (GitHub landing page)packages/kit/README.mdis removed from git and gitignoredprepublishOnlyscript that copies root README intopackages/kit/at publish time so npm gets the full docsTest plan
npm pack --dry-runconfirms full 9.4kB README is included in the tarball🤖 Generated with Claude Code