Skip to content

docs: ship-ready cleanup pass — DRY, accurate, no AI-tell - #247

Merged
aram-devdocs merged 2 commits into
mainfrom
chore/docs-cleanup-pre-v0
May 7, 2026
Merged

docs: ship-ready cleanup pass — DRY, accurate, no AI-tell#247
aram-devdocs merged 2 commits into
mainfrom
chore/docs-cleanup-pre-v0

Conversation

@aram-devdocs

Copy link
Copy Markdown
Owner

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.

  • README is now a tight elevator pitch: 4-line install block + link to install.html. No more "walking skeleton" / "coming soon" / "placeholder" status text.
  • install.md drops the pre-release notice block and the "Status: Available at first release" column. Adds the npm channel.
  • introduction.md drops the redundant Status section, adds the npm link, repoints "build from source" at hacking-on-Plumb rather than "the only path today".
  • cli.md adds --auto-fetch-chromium (was missing); drops the hidden --once from the watch flag table.
  • blog/launch-v0.6.md drops the "supported path is still build from source" claim now that brew/npm/curl/cargo are wired.
  • ci/github-code-scanning.md and ci/reviewdog.md replace cargo install --git ... plumb with cargo install plumb-cli.
  • mcp/compare-viewports.md fixes the broken lint_url.md link and the local/prd.md link (PRD is gitignored).
  • mcp/claude.md drops the long "Verified locally" JSON blob and the "walking-skeleton URL" framing — the canonical example already lives in mcp.md.
  • rules/baseline-rhythm.md fixes the PRD SS11.3 -- typo to PRD §11.3 — .

Out of scope

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.

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} --help cross-checked against cli.md.

🤖 Generated with Claude Code

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.
@aram-devdocs aram-devdocs changed the title docs: V0 ship-ready cleanup pass — DRY, accurate, no AI-tell docs: ship-ready cleanup pass — DRY, accurate, no AI-tell May 7, 2026
@github-actions

github-actions Bot commented May 7, 2026

Copy link
Copy Markdown
Contributor

Now I have enough to write a complete review.


PR #247 — docs: ship-ready cleanup pass — DRY, accurate, no AI-tell

Scope: Docs-only. No Rust code changes, no Cargo.toml changes.

1. Determinism, layering, error handling, test coverage

All four checks pass trivially — no Rust source was modified.

2. Documentation accuracy

Changes are factually correct against the codebase:

  • --auto-fetch-chromium confirmed in crates/plumb-cli/src/main.rs:160,261 — addition is accurate.
  • --once confirmed hidden/internal (crates/plumb-cli/src/commands/watch.rs:19 comment) — removal from user-facing docs is correct.
  • cargo install --git … plumbcargo install plumb-cli matches the unscoped rename from PR chore(ci): switch npm to unscoped plumb-cli + enable in cargo-dist installers #246.
  • Version pin updated from 0.1.00.0.2 — matches current release.
  • ./lint_url.md link in compare-viewports.md was broken (no such file in docs/src/mcp/); fix is valid.
  • ../../local/prd.md link was pointing to a gitignored file; fix is valid.

3. Punch list

Minor — not blockers:

  • README.md (old line ~43): [Code of conduct](CODE_OF_CONDUCT.md) was silently removed. The file exists and is the normal OSS governance link. Either keep it or document why it was dropped — removing it without mention is surprising.

  • docs/src/mcp/compare-viewports.md:125: The replacement link [Configuration](../configuration.md) stands in for "PRD §14.2 — MCP response shape." configuration.md covers plumb.toml; it says nothing about MCP response shape. A more accurate replacement would be [MCP server reference → response shape](../mcp.md#response-shape) or similar. As-is, the "See also" entry misleads the reader about what they'll find.

  • docs/src/mcp/claude.md (removed "Verified locally" block): mcp.md shows the envelope shape but uses /* … */ for violations. The removed example was the only place the complete violation object (all 9 fields + nested fix.kind) appeared in a rendered doc. The loss is minor since the schema is implied by the rules pages, but there's now no single worked example a reader can copy-paste.

  • Anti-AI-writing check: new prose is clean — no flagged phrases from .agents/rules/documentation.md.


Verdict: APPROVE

…e-v0

# Conflicts:
#	docs/src/install.md
#	docs/src/introduction.md
@aram-devdocs
aram-devdocs merged commit d56262f into main May 7, 2026
27 of 34 checks passed
@aram-devdocs
aram-devdocs deleted the chore/docs-cleanup-pre-v0 branch May 7, 2026 07:40
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