Skip to content

README: restructure pair-first — two journeys, four commands#20

Merged
CognitiveCodeAI merged 3 commits into
mainfrom
docs/readme-pair-first
Jun 9, 2026
Merged

README: restructure pair-first — two journeys, four commands#20
CognitiveCodeAI merged 3 commits into
mainfrom
docs/readme-pair-first

Conversation

@CognitiveCodeAI

Copy link
Copy Markdown
Owner

Why

With audit-repair shipped in v0.4.0, the README presents four commands, and they read as four choices the user must get right. They're not — they're the steps of two journeys with the same shape: plan → you approve → execute. This PR restructures the README so the journey is the unit you pick, and the commands are just its steps. Presentation only — no skill, manifest, or behavior changes.

What changed

  • ## 🧭 Which to reach for## 🧭 Two journeys, four commands. The four-row situation table becomes a two-row journey table — make it run (discover → approve → repair) and assess it, optionally fix it (audit → your call → audit-repair). The guard moves from a table row to a standing sentence (it isn't a choice).
  • New callout — the self-routing nobody knew about: don't memorize the order, start anywhere. repair with no plan stops and offers discover; discover names the next command; audit-repair refuses without a ratified audit. This was already true in the skills; the README never said it.
  • Mermaid diagram catches up to v0.4.0: the audit journey dead-ended at CODEBASE_AUDIT.md (drawn pre-audit-repair). It now shows the optional ratify → audit-repair → findings-fixed leg, dotted to signal opt-in.
  • Command table split into the two journey groups (rows themselves unchanged apart from one trailing cross-reference trim).
  • Intro bullets name their command pairs; the assess bullet now mentions the optional fix leg; "nothing changes until you approve a plan" now covers both journeys.
  • FAQ: "will it change my code" and the reload-plugins answer now account for audit-repair.

Stacking

Based on #19 (feat/discover-repairability-verdict), because both touch the command-table rows. Merge #19 first — GitHub will retarget this PR to main automatically. Review here shows only the restructure.

Context

Follows the "don't merge discover+repair" decision: the four-skill architecture stays exactly as is (the ratify gate is load-bearing and Plan-Mode-enforced); the confusion was in the telling, so the fix is in the README.

🤖 Generated with Claude Code

CognitiveCodeAI and others added 2 commits June 9, 2026 15:11
…uses not-repairable

DISCOVERY.md previously had no way to say 'this can't be repaired because
it was never built' — only blocker severity. Now:

- discover emits a top-of-file Repairability verdict
  (repairable | partially-runnable | not-repairable) and splits fixable
  blockers from never-built gaps; gaps never become DoD checkboxes
- repair gains a second refusal: it stops on not-repairable, keeps gaps
  out of scope on partially-runnable, and treats a missing verdict field
  (pre-existing DISCOVERY.md files) as repairable
- README + OVERVIEW updated to match

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Four commands read as four choices; they're not. Lead with the two
journeys (discover→repair, audit→audit-repair), each plan → you approve
→ execute:

- 'Which to reach for' becomes 'Two journeys, four commands' — a
  two-row journey table (guard as a standing line, not a row)
- new callout: don't memorize the order — every skill routes you to
  the right phase (repair offers discover; audit-repair refuses
  without a ratified audit)
- mermaid finally shows the audit→audit-repair leg (it dead-ended at
  the report, predating v0.4.0)
- command table split into the two journey groups
- intro bullets name their command pairs; FAQ rows catch up to
  audit-repair

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Base automatically changed from feat/discover-repairability-verdict to main June 9, 2026 19:22
@CognitiveCodeAI CognitiveCodeAI merged commit f770b10 into main Jun 9, 2026
1 check passed
@CognitiveCodeAI CognitiveCodeAI deleted the docs/readme-pair-first branch June 9, 2026 19:23
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