Repository navigation
docs: slim the README to a landing page and move the full reference to GUIDE.md - #116
Merged
Merged
Conversation
The README keeps the pitch, install, Quick Start and links. Every other section moves word for word, so GUIDE.md headings keep the old anchors.
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.
What
GUIDE.md, under the same headings, so its anchors match the old README's.llms-full.txtserves both.GUIDE.md.Why
The README held the whole docs site on one page (60+ sections). For comparison, cmdk's README is 1,608 words and kbar's is 800.
Testing
lint,typecheck,format:check,build: pass.test: 767/767.test:dist: 29/29.GUIDE.mdfence fails the docs test atGUIDE.md:342.README.mdandGUIDE.mdresolve.llms-full.txthas both files without the test markers.npm shows the README from the published package, so the npm page changes with the next release.
Size
Added lines by type, blank lines excluded. Comments counts comment lines in non-test code.
Removed: 1,058 lines. Tests include 10 comment lines.