docs(readme): restructure for readability and de-duplicate install - #77
Merged
Merged
Conversation
Reorganize the README into a clearer top-down flow without changing any substance: - Group content into "What it does" (issue-to-PR flow, plan-backlog, quality gates, stack-agnostic), "Getting started" (one Installation section + connect-your-tracker), "Using it", "Reference", and meta. - Consolidate the install one-liner + per-host table, which was duplicated in three places, into a single Installation section with per-host subsections (Claude Code, Codex, Copilot, Cursor, and the cross-client explainer that "Also runs on…" used to hold). - Keep the demo at the top next to the pitch. - Fix internal anchors after the moves (#installing-in-claude-code → #installation, #cursor--… → #cursor, dropped the absorbed "also-runs-on" anchor); the redundant inline troubleshooting note is covered by the Troubleshooting table. Docs-only; README is not bundled, so no version bump or rebuild. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
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.
What
Reorganizes the README into a clearer top-down flow — the content felt a bit chaotic (install steps in particular were duplicated in three places). No substance changed; everything is preserved verbatim, just regrouped and de-duplicated.
New structure
Key change
The install one-liner + per-host table was duplicated across three sections ("How it works", "Installing in Claude Code", "Also runs on Codex/Cursor/Copilot"). Those are now one Installation section with per-host subsections. Internal anchors updated accordingly (
#installing-in-claude-code→#installation,#cursor--…→#cursor); the redundant inline troubleshooting note is already covered by the Troubleshooting table.Scope
Docs-only. The README is not bundled into the plugin, so no version bump and no rebuild needed.
🤖 Generated with Claude Code