docs: polish README and fix staleness across docs/ - #86
Merged
Conversation
Documentation quality pass over the README and docs/ tree. No behavior changes. README: - Tighter intro that leads with what the tool is and does; fix "Claude Cowork" capitalization. - New Quickstart section (the two primary commands) near the top. - De-duplicate "What it's for" against the Quickstart; keep the non-destructive `--agents-only` point and the sandbox/verify principles. - Move a slimmed Documentation index below the Flavors table (the table already links each flavor doc) and add the missing releases.md pointer. Accuracy fixes (the `iac` flavor was added but several docs predate it): - docs/cli.md: "six subcommands" -> seven; add `iac` to the list-flavors example and the unknown-flavor error example. - docs/engine/flavor-hooks.md: "all three code flavors" -> four (iac). - docs/README.md: add flavors/iac.md to the layout tree; mark all flavor docs done; the backlog is now just the four engine-capability docs. Stale source line refs refreshed to current locations (scaffold.go grew to 513 lines): Run 31->62, createSymlinks 209->335, NextSteps print 272-289->printNextSteps:470, codeFlavorSymlinks registry.go 70-76->145-151, and the flavor.go field/type refs in flavor-hooks.md and claude-cowork.md. Verified example output against the built binary (list-flavors, the unknown-flavor error, the seven-command help). TestHelpFlagsMatchDocs and the full test suite pass. 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.
A documentation quality pass over the README and the
docs/tree. No behavior changes; verified accurate against the source and the built binary.README
--agents-only) command, the fresh-project command, andlist-flavors/--help.--agents-onlyguarantee and the sandbox / verify principles, dropped the repeated command block.releases.mdpointer.Accuracy fixes
The
iacflavor shipped after several docs were written; they hadn't caught up:docs/cli.md: "a small CLI with six subcommands" → seven; addediacto thelist-flavorsexample and to the unknown-flavor error example (both matched against real binary output).docs/engine/flavor-hooks.md: "All three code flavors" → four (fullstack,go-cli,go-backend,iac).docs/README.md: addedflavors/iac.mdto the layout tree, marked all flavor docs done, and trimmed the backlog to the four remaining engine-capability docs.Stale source refs refreshed
scaffold.gogrew to 513 lines, so severalfile:linelinks pointed at the wrong code. Corrected:Run31→62,createSymlinks209→335, the NextSteps print path 272-289→printNextSteps:470,codeFlavorSymlinksregistry.go70-76→145-151, and theflavor.gofield/type refs inflavor-hooks.mdandclaude-cowork.md.Verification
Ran the binary and matched examples to reality (
list-flavors, the unknown-flavor error, the seven-command--help).TestHelpFlagsMatchDocsandgo test ./...pass.Out of scope (noted, not done): the four
TODOengine-capability docs (templates.md,path-templating.md,common-overlay.md,done-gate.md) still don't exist — the backlog now tracks them accurately.🤖 Generated with Claude Code