docs: slim the root README and move reference material to docs/ - #25
Merged
Conversation
Adds four reference pages that hold detail moved out of the root README: installation methods, the CLI command reference, per-skill detail, and the development guide.
Rewrites the 257-line README as a 71-line landing page and links out to the new docs/ reference pages for installation, CLI usage, skills, and development.
5 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.
Closes #24
Why
The root README was 257 lines and carried reference material a landing page should not — four installation methods, the full CLI reference with example JSON, per-skill detail, and a development section with prerequisites, setup, commands, and the project tree. Meanwhile
docs/held a single file. A reader had to scroll past all of it to learn what upkeep is and how to install it.What moved
docs/INSTALLATION.md— all install methods, plus checksum verification and a PATH troubleshooting notedocs/CLI.md— command table, global flags, example output, and the configuration sectiondocs/SKILLS.md— plugin install and per-skill detaildocs/DEVELOPMENT.md— prerequisites, setup, command table, versioning, project structure, commit conventionsRoot README is now 71 lines and links to each.
Corrections made while moving
These were stale, not just relocated:
UPKEEP_VERSION=v0.2.0, nowv0.5.0engines.bunis>=1.3.0, and CI pins 1.4.0Content added that did not exist before
Worth a reviewer's eye, since it is new prose rather than moved text:
brew upgrade— previously undocumented and a plausible source of confusiontypescript-apialias for runtime AST parsing), including the two consequences:bun outdatedpermanently reportingtypescript 6.0.3 -> 7.0.2as a false positive, and why the typecheck script uses an explicit binary pathjust installinstalls dependencies and does NOT put a binary on PATH, which is a real papercutOne deliberate editorial change
The old "Features" bullet list was folded into a short intro paragraph. Every capability it named is still documented —
riskanddependabotboth appear in the CLI command table in docs/CLI.md.Verification
justrecipe named in DEVELOPMENT.md confirmed to exist viajust --listjust show-versionsjust checkpasses (lint, typecheck, 405 tests)