docs: align sync/snapshot AGENTS docs, README, and changelog for v1.0.0 - #162
Conversation
|
@claude please review this PR — it is docs-only (AGENTS docs, README, CHANGELOG). Focus on factual accuracy against the current code: the 12 capture steps, the snapshot JSON field names, the sync flow description (additive-only, no openboot sync command), and whether the CHANGELOG v1.0.0 bullets accurately describe the #160 behavior changes. |
|
Claude finished @fullstackjam's task in 2m 13s —— View job Review: docs/AGENTS accuracy check
Checked every factual claim in the diff against the current code (not just the doc's own internal consistency). Confirmed accurate:
Issue found — stale line adjacent to this PR's own edit:
Minor, not introduced by this PR:
Everything else in the diff (README |
|
Claude finished @fullstackjam's task in 25s —— View job Re-review: delta from f7dca23
Both findings from the prior review are correctly addressed in f7dca23. 1. README 2. Stale No new issues introduced by this follow-up commit. LGTM. |
What does this PR do?
Aligns the last stale docs with the current CLI ahead of cutting v1.0.0: fixes
internal/sync/AGENTS.md(referenced a nonexistentopenboot synccommand andcli/sync.go), updatesinternal/snapshot/AGENTS.md(8→12 capture steps;dock.go/loginitems.goand the real JSON field names were missing), adds--pickto the README options list, and retitles the CHANGELOG section to v1.0.0 with two bullets for the #160 behavior changes (interactive dry-run,--updatehelp correction).Why?
A project review found these as the remaining doc-drift items after #157. They are the last in-repo blockers before tagging v1.0.0 — the v1.0 spec in CHANGELOG.md is otherwise fully implemented.
Testing
go vet ./...passesgo test ./internal/archtest/...passes (agent-config topology untouched); full L1 ran via pre-push hookCross-repo checklist
openboot.dev? — No: CLI-internal docs; README--pickline documents an existing flagNotes for reviewer
Content claims were verified against the code before writing: capture steps enumerated from
captureStepsininternal/snapshot/capture.go, snapshot JSON keys from struct tags ininternal/snapshot/snapshot.go, and the additive-only sync note frombuildInstallPlanininternal/cli/sync_helpers.go. A separate session is handling the required-checks.txt / MERGE_POLICY alignment — deliberately not touched here.