Skip to content

docs: comprehensive documentation audit and fixes#49

Open
jmanhype wants to merge 8 commits intomikehostetler:mainfrom
jmanhype:docs/comprehensive-documentation-audit
Open

docs: comprehensive documentation audit and fixes#49
jmanhype wants to merge 8 commits intomikehostetler:mainfrom
jmanhype:docs/comprehensive-documentation-audit

Conversation

@jmanhype
Copy link
Copy Markdown
Collaborator

Summary

  • Create MIGRATION.md — was referenced in README, CHANGELOG, and package.json but never existed
  • Fix state name drift — docs used raw but code uses idea as initial state (renamed in ccd3938); fixed across all doc files
  • Add missing critique phase — present in code but entirely absent from all documentation (state diagrams, phase tables, CLI examples)
  • Document 8 undocumented commandsrollback, shell, summarize, execute-roadmap, check-integrity, watchdog, strategy, dream
  • Document 8 undocumented flags--parallel, --no-resume, --retry-failed, --no-healing, --agent, --rlm, --mock-agent, --sandbox
  • Fix version mismatchsrc/index.ts reported 0.0.1 but package.json says 1.0.0; aligned both
  • Rewrite CHANGELOG.md — was abandoned after initial v1.0.0 entry; now covers all features
  • Clean up stale files — moved dev notes from specs/ to docs/internal/, deleted empty specs/fix-issues.md
  • Fix wrong path in specs/010-doctor.md (src/doctor.tssrc/commands/doctor.ts)

Files Changed (18 files, +815/-221)

Category Files
New MIGRATION.md
State fix (rawidea) docs/guide/loop.md, docs/cli/phases.md, docs/cli/flags.md, docs/cli/essentials.md, docs/guide/folder-structure.md
Critique phase README.md, AGENTS.md, CLAUDE.md (via AGENTS.md), docs/guide/loop.md, docs/cli/phases.md
New commands/flags README.md, AGENTS.md, docs/cli/essentials.md, docs/cli/flags.md
Version fix src/index.ts, src/__tests__/cli.test.ts
Cleanup CHANGELOG.md, specs/009-cli.md, specs/010-doctor.md, docs/migration/*
Moved specs/fix-git-tests-ci.mddocs/internal/
Deleted specs/fix-issues.md (empty)

Test plan

  • bun run typecheck passes
  • bun run build succeeds
  • bun test — 1577/1577 pass (0 fail)
  • CLI dogfood tested on fresh repo: init, ideas, status, list, show, doctor, --dry-run, --mock-agent, meta-agents, edge cases (bad IDs, wrong state transitions, empty input)
  • Verified both fork and upstream produce identical test results
  • No behavioral changes — documentation only (except version alignment)

🤖 Generated with Claude Code

jmanhype and others added 8 commits February 11, 2026 23:04
Local-only repos (no git remote) failed during direct merge because
`git pull --ff-only` errored. Now checks `git remote` first and skips
the pull step if empty, enabling direct merge mode on repos without
a remote origin.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Item 093: add missing `notes` fields to all stories
- Item 048: convert `description` to `acceptance_criteria`, add `notes`
- Item 092: reset orphaned `in_pr` state to `planned` (no branch exists)
- Item 001: priority clamping (auto-fixed by doctor)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- #50: Critique phase now commits metadata (state + progress.log)
- #48: Branch checkout stashes uncommitted changes before switching
- #45: ensureBranch() pulls latest base before creating new branches
- #46: Merge conflict aborts cleanly and restores feature branch
- #43: Post-merge anti-clobber restores other items' item.json from pre-merge SHA
- #51: Critique prompt now instructs agent to run tests + typecheck
- #52: Anti-gaming rules in implement + critique prompts (no stubs, no gaming tests)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…ber regression

Dogfooding revealed that the "done" state written after mergeAndPushToBase()
was never committed to git. When a subsequent item's anti-clobber restored
item.json files from the pre-merge SHA, it would revert the previous item
back to "critique" state. Adding a commit after the done+progress.log write
ensures the state is persisted in git history.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
… compatibility

Bun's test runner eagerly creates rejected promises from mockRejectedValue(),
triggering unhandled rejection errors before the mock is called. Using
mockImplementation(async () => { throw ... }) defers the rejection until
the mock is actually invoked, fixing 5 pre-existing test failures.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Reset 7 stuck items (in_pr/critique/planned/researched) back to idea
- Delete stale branches (fix/real-sdk-integrations, wreckit/064, wreckit/065)
- Remove stale files (OBSERVED_ISSUES.md, backups, jido-brainstorm, rlm diagrams)
- Update README with: direct merge mode docs, critique phase, meta-agents,
  rollback command, merge safety features, correct state flow, current config

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Analysis of 208 wreckit executions across 12 projects. Key findings:
93.5% AUC predicting task success from planning-phase signals alone,
direct merge 75% vs PR 40.5% success, 83% of failures before coding.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Fix documentation drift across 16+ files discovered during full audit:
- Create MIGRATION.md (was referenced everywhere but didn't exist)
- Fix state name drift: `raw` → `idea` throughout all docs
- Add missing `critique` phase to all state diagrams and tables
- Document 8 undocumented commands (rollback, shell, summarize, etc.)
- Document 8 undocumented flags (--parallel, --mock-agent, --rlm, etc.)
- Fix version mismatch: src/index.ts 0.0.1 → 1.0.0 to match package.json
- Rewrite CHANGELOG.md with comprehensive feature coverage
- Replace placeholder in quick-migration.md with actual content
- Move stale dev notes from specs/ to docs/internal/
- Delete empty specs/fix-issues.md
- Fix wrong path in specs/010-doctor.md (src/doctor.ts → src/commands/doctor.ts)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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