docs: rewrite README to house standard - #180
Merged
Merged
Conversation
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.
Summary
Rewrites the README to the shared house structure: a one-line pitch and dynamic badge row, npm-first installation, a credential-free 60-second mapping path, the provider-backed review path, progressively deeper workflow sections, development commands, and license.
The README is now 103 lines instead of 230. The existing banner remains near the top.
Content movement
No new docs were needed. The removed exhaustive material already lives in the focused guides:
docs/feature-mapping.mddocs/providers.mddocs/quickstart.md,docs/code-review.md,docs/patching.md,docs/reporting.md, anddocs/validation.mddocs/configuration.mdanddocs/safety.mdDropped as obsolete: the "early CLI" status, the "next steps"/coming-soon mapper sentence, and the stale claim that a future v0.4 would remove legacy report JSON keys (the project is now v0.7.x). No factual feature coverage was discarded.
Verification
main; primary workflow is.github/workflows/ci.yml.clawpatchis published on npm (npm view clawpatch versionreturned0.7.2), Node>=22is declared, both pnpm and npm global install paths succeed, and neither checked Homebrew tap contains a formula or cask.init,map,status, andreportsucceeded; mapping found four features without calling a provider.doctorandreviewcommands, plus all workflow commands and documented flags, against the built CLI's real--helpoutput. No model call was made because it requires provider credentials.pnpm typecheck,pnpm lint,pnpm format:check,pnpm test,pnpm build, andpnpm pack:smokepassed (29 test files; 900 tests passed, 1 skipped).