docs: retarget phase 1 acceptance criterion to checked-in fixture - #122
Merged
Conversation
aram-devdocs
changed the title
aram-devdocs
force-pushed
the
codex/120-docs-phase-1-acceptance-url
branch
from
April 25, 2026 16:24
fcd068a to
fb467ef
Compare
The phase 1 acceptance criterion in `docs/runbooks/phase-1-spec.yaml` pre-conditioned on `https://plumb.aramhammoudeh.com` resolving, but that URL is a 404 — the docs site is a phase 6 deliverable (#56). Anyone running the gate today gets a Chromium navigation error instead of a clean rule violation. Replace the URL with a `file://` reference to the checked-in fixture at `crates/plumb-cdp/tests/fixtures/static_page.html`. The fixture's `padding:13px` on `<body>` is off-grid against the default `spacing.base_unit = 4`, so `spacing/grid-conformance` fires deterministically. The fixture is already exercised by the `e2e-chromium` driver contract test, so the path is exercise-tested. Note that the docs-site URL becomes a valid additional target once phase 6 (#56) ships. Closes #120
aram-devdocs
force-pushed
the
codex/120-docs-phase-1-acceptance-url
branch
from
April 25, 2026 16:25
fb467ef to
1846d40
Compare
Contributor
|
I have everything I need. Let me now write the review. Review:
|
| Check | Result |
|---|---|
New unsafe outside plumb-cdp |
N/A — docs only |
unwrap/expect/panic! in library |
N/A |
println!/eprintln! outside plumb-cli |
N/A |
SystemTime::now/nondeterminism in plumb-core |
N/A |
todo!/unimplemented!/dbg! |
N/A |
HashMap/HashSet in observable output |
N/A |
| New GPL/AGPL dep | N/A |
| Rule added without golden test + register + docs page | N/A |
docs/src/** changed → humanizer required |
No — only docs/runbooks/** changed |
All blockers clear.
Substantive findings
None.
Correctness verified:
crates/plumb-cdp/tests/fixtures/static_page.htmlexists in the repo ✓- The fixture contains
<body style="margin:0; padding:13px;">✓ — 13 is not divisible by 4 (spacing.base_unit = 4), sospacing/grid-conformancefires as claimed ✓ - Both changed locations (
acceptance_criteria[0]andphase_gate.criterion) are updated consistently ✓ - The forward reference to Phase 6 / issue [RUNBOOK] Phase 6 — Docs + dogfooding #56 is accurate and does not create a gate dependency ✓
- The
$REPOsubstitution note is explicit in both inline text and commit message — this is a human-facing runbook doc, so manual substitution is appropriate ✓ - Commit format:
docs: retarget …— valid Conventional Commits ✓
Minor observation (non-blocking):
docs/runbooks/phase-1-spec.yaml:22— the newacceptance_criteriastring is long (single YAML line). Could be split with a YAML block scalar (|) for readability, but the schema likely accepts either form and it doesn't affect generated output.
Verdict: APPROVE
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.
Summary
Closes #120 — the phase 1 acceptance criterion in
docs/runbooks/phase-1-spec.yamlpre-conditioned onhttps://plumb.aramhammoudeh.comresolving, but the docs site is a phase 6 deliverable (#56). Anyone re-running the gate today gets a Chromium navigation error instead of a clean rule violation.Fix
Replace the URL in both the parent-issue acceptance criterion and the phase-gate criterion with a
file://reference to the existing checked-in fixture atcrates/plumb-cdp/tests/fixtures/static_page.html.Why this fixture
chromium_driver_captures_static_fixtureincrates/plumb-cdp/tests/driver_contract.rs(gated behind thee2e-chromiumfeature) already drives Chromium against this exact path.body { padding: 13px }is off-grid for the defaultspacing.base_unit = 4, sospacing/grid-conformancefires every run.https://plumb.aramhammoudeh.combecomes an additional valid acceptance target once phase 6 ([RUNBOOK] Phase 6 — Docs + dogfooding #56) ships.This matches option 3 from the issue ("checked-in HTML fixture served via
file://"), which the issue author flagged as the lowest-friction option.What's NOT changed
plumb.aramhammoudeh.com(ruledoc_urlstrings, SARIFinformationUri,Cargo.tomlhomepage, README install link, schema$ids, phase-3/phase-6/roadmap specs). These are aspirational, will resolve when phase 6 ships, and are not what docs: phase 1 acceptance URL https://plumb.aramhammoudeh.com is 404 (docs site is not yet deployed) #120 is reporting.crates/plumb-cli/tests/cli_integration.rs:61andcrates/plumb-cdp/tests/driver_contract.rs:68reference the URL but never resolve it (the former asserts the Chromium-not-found error path; the latter assertsis_fake_urlreturnsfalse). Both stay correct under any URL choice.Test plan
cargo xtask validate-runbooks— 8 specs valid.just validate— all gates pass (fmt + clippy-D warnings+ nextest + cargo deny + audit).Layer / determinism / scope
docs/runbooks/phase-1-spec.yaml).🤖 Generated with Claude Code