Skip to content

docs: slim the README to a landing page and move the full reference to GUIDE.md - #116

Merged
Priyans-hu merged 4 commits into
mainfrom
docs/slim-readme
Oct 12, 2026
Merged

Priyans-hu merged 4 commits into
mainfrom
docs/slim-readme

Conversation

@Priyans-hu

@Priyans-hu Priyans-hu commented Oct 12, 2026 •

Copy link
Copy Markdown
Owner

What

  • The README is now a landing page: the pitch table, install, Quick Start, a feature list with links, and docs links. It goes from 1,416 lines (7,582 words) to 134 lines (881 words).
  • Every other section moves word for word to GUIDE.md, under the same headings, so its anchors match the old README's.
  • The docs test now type-checks the marked fences in both files, and llms-full.txt serves both.
  • Comments that pointed at README sections now point at 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.
  • Mutation: a type error put in a GUIDE.md fence fails the docs test at GUIDE.md:342.
  • All 46 anchor links in README.md and GUIDE.md resolve.
  • The docs site builds, and its llms-full.txt has 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.

Code Tests Comments Docs and config
4 31 7 1,062

Removed: 1,058 lines. Tests include 10 comment lines.

@Priyans-hu
Priyans-hu merged commit 3910a05 into main Oct 12, 2026
8 checks passed
@Priyans-hu
Priyans-hu deleted the docs/slim-readme branch October 12, 2026 17:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant