docs: install + quick-start + config reference chapters - #135
Conversation
Adds docs/src/install.md (4 channels), docs/src/quickstart.md (5-minute first run), and rewrites docs/src/configuration.md as the full plumb.toml reference. Wires the canonical schema URL (https://plumb.aramhammoudeh.com/schemas/plumb.toml.json) into the editor-tooltip example so JSON-Schema-aware editors pick it up. SUMMARY.md grows a Getting started section; introduction.md links out to the new chapters. Closes #57. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
I have enough data for a complete review. Here's the full assessment: PR #135 —
|
| File | Line | Issue |
|---|---|---|
docs/src/configuration.md |
219–221 | False claim that CI validates schema defaults against examples/plumb.toml — fix to describe what the tests actually check |
docs/src/quickstart.md |
44–51 | Exit code 0 described as "No violations" — doesn't cover Info-only runs; two Info-severity rules are active |
Verdict: REQUEST_CHANGES
Target branch
mainSpec
Fixes #57 — part of the Phase 6 runbook (
#56), batch6Acore docs chapters.Summary
docs/src/install.mdcovering all four release channels (install script,cargo install, Homebrew, build-from-source) with an honest pre-release status table.docs/src/quickstart.mdwalking the five-minute first-run path: sanity check →plumb init→ real-URL lint → JSON / SARIF / per-rule overrides → editor schema wiring → MCP server.docs/src/configuration.mdas the fullplumb.tomlreference: every section (viewports,spacing,type,color,radius,alignment,a11y, per-rule overrides) with copy-pasteable TOML, defaults table, and the consuming rule. Wires the canonical schema URLhttps://plumb.aramhammoudeh.com/schemas/plumb.toml.jsoninto editor-tooltip examples for VS Code (Even Better TOML) and JetBrains.docs/src/SUMMARY.mdwith a new "Getting started" section and reorders the existing "Using Plumb" section. Refreshesdocs/src/introduction.mdnext-links to surface install + quickstart first.Crates touched
docs/System impact
None of the schema / API / rule / dependency boxes apply — this is a pure docs change.
Architectural compliance
No code touched; layer / error / determinism rules are inapplicable. Markdown-only diff.
Test plan
bash scripts/check-agents-md.shpasses (line budgets, AGENTS scopes OK).just validate(Rust toolchain could not install in the local sandbox — disk full; relying on GitHub CI).delve,tapestry,landscape,leverage,comprehensive,seamless, etc.), no negative-parallelism, em-dash density acceptable.Documentation
docs/src/updated (this PR's reason for existing).Breaking change?
Checklist
docs: …)gh-issue-57-issue-57-20260427225628, created by the worktree harness rather than the canonicalcodex/57-docs-...shape. Kept as-is to avoid PR churn; advisory..github/workflows/claude-code-review.ymlplus human review./gh-review --local-diff main...HEADskipped —python3and the Rust toolchain were unavailable in this sandbox, so the review-gate scripts couldn't run.Reviewer notes
install.md) is deliberately honest about which channels work today vs. which are wired up but not yet released. Match this against the README the next time the release script changes.https://plumb.aramhammoudeh.com/schemas/plumb.toml.json. If the docs site path changes, this URL needs to update in three places:install.md,quickstart.md,configuration.md.[a11y]and[alignment]tables come fromschemas/plumb.toml.json— let me know if they fall out of sync with the schema and I'll resync.