docs: trim README (715 → 623 lines)#27
Merged
Merged
Conversation
The README listed capabilities three times: the Comparison table, a 98-line Feature checklist, and the Commands reference — plus per-version "New in vX" blurbs that the CHANGELOG now owns. That triple-inventory is what made it read unusually long. - Collapse the two "New in v0.6/v0.4" blurbs + the "v0.5 shipped" section into a one-line changelog/releases pointer. - Replace the 98-line Feature checklist with a ~25-line capability map. Every headline feature is kept (caption real-objects, lint CI, dry-run, restore, both namespaces, integrations); only the per-version subsections that duplicate the CHANGELOG are dropped. Roadmap kept. Preserved verbatim: hero, Comparison table, problem statement, full install + all command docs/examples, LLM-driven narrative, Troubleshooting, Examples, Gumroad/author CTAs. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <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.
Not for auto-merge — your review. You flagged the README as unusually long; this trims the redundancy without touching positioning.
Root cause
Capabilities were listed three times: the Comparison table, a 98-line ✅/⬜ Feature checklist, and the Commands reference — plus "New in vX" blurbs the CHANGELOG now owns.
Changes (−92 lines, −13%)
Preserved verbatim
Hero, Comparison table, problem statement, full install + every command doc/example, the LLM-driven transcript, Troubleshooting, Examples, and all Gumroad/author CTAs. No internal links broken.
If you want to go further
The remaining length is mostly the legitimate command reference (45 commands) + examples. I could move the full command reference into a
COMMANDS.mdand keep the README to quickstart + capability map (~350 lines), but that's a bigger restructure — say the word.🤖 Generated with Claude Code