docs: ship-ready cleanup pass — DRY, accurate, no AI-tell - #247
Conversation
Pre-V0 (0.0.2) docs sweep: align every public doc surface with the actual binary behavior, drop pre-alpha hedging now that the four install channels are wired, and remove the duplicated install copy that drifted between README, install, and introduction. - README.md: drop the aram-ai-global tagline, "walking skeleton" status, "coming soon"/"placeholder" hedges, and the pre-release install caveat. Install section is now four lines (curl, cargo, brew, npm) plus a link to the canonical install page. - docs/src/install.md: drop the pre-release notice block and the "Status" column. Keep per-channel notes; bump the cargo pin example to 0.0.2; add the npm channel. - docs/src/introduction.md: drop the pre-alpha Status section, add the npm install link, point "build from source" at the hacking-on-Plumb path instead of "the only path available today". - docs/src/configuration.md: drop "walking skeleton" framing on the default-viewport note. - docs/src/cli.md: add `--auto-fetch-chromium` to the lint flag table; remove the hidden `--once` from the watch flag table. - docs/src/blog/launch-v0.6.md: drop the "supported path is still build from source" claim now that brew/npm/curl/cargo are wired; trim the install duplication and link to install.md. - docs/src/ci/github-code-scanning.md, ci/reviewdog.md: replace `cargo install --git ... plumb` with the canonical `cargo install plumb-cli`. - docs/src/mcp/compare-viewports.md: fix the broken `lint_url.md` link and the `local/prd.md` link (PRD is gitignored). - docs/src/mcp/claude.md: drop the long "Verified locally" JSON blob and the "walking-skeleton URL" framing — the canonical example already lives in mcp.md. - docs/src/rules/baseline-rhythm.md: fix `PRD SS11.3 -- ` typo to `PRD §11.3 — `. Note: docs/src/ci/release-prep.md is intentionally untouched. The install-smoke validator (`tests/install-smoke-validate.sh`) on origin/main pins the exact "#51 wired / #52 prep-only" wording in that page; the unscoped-npm switch (PR #246) updates both files together and will replace the prep-only block.
|
Now I have enough to write a complete review. PR #247 — docs: ship-ready cleanup pass — DRY, accurate, no AI-tellScope: Docs-only. No Rust code changes, no 1. Determinism, layering, error handling, test coverageAll four checks pass trivially — no Rust source was modified. 2. Documentation accuracyChanges are factually correct against the codebase:
3. Punch listMinor — not blockers:
Verdict: APPROVE |
…e-v0 # Conflicts: # docs/src/install.md # docs/src/introduction.md
Summary
Pre-V0 (0.0.2) docs cleanup. Aligns every public surface (README, mdBook book, crate READMEs) with the actual binary behavior; drops pre-alpha hedging now that the four install channels are wired; removes duplicated install copy that drifted between README, install.md, and introduction.md.
--auto-fetch-chromium(was missing); drops the hidden--oncefrom the watch flag table.cargo install --git ... plumbwithcargo install plumb-cli.lint_url.mdlink and thelocal/prd.mdlink (PRD is gitignored).PRD SS11.3 --typo toPRD §11.3 —.Out of scope
docs/src/ci/release-prep.mdis intentionally untouched. The install-smoke validator (tests/install-smoke-validate.sh) on origin/main pins the exact "#51 wired / #52 prep-only" wording in that page; the unscoped-npm switch (PR #246) updates both files together and will replace the prep-only block.Test plan
cargo run -p xtask -- pre-release— green (16 rules / docs match, 9 runbook specs valid, 12 release-readiness kits valid).cargo run -p xtask -- sync-rules-index— green.just check— green (fmt, clippy-D warnings, dep-policy, install-smoke-validate, release-security-validate, all 10 stages).mdbook build docs— clean build, no broken intra-doc links.cargo test --workspace --lib --tests— all green.plumb {lint,init,mcp,watch,explain,schema} --helpcross-checked against cli.md.🤖 Generated with Claude Code