docs: publish a condensed public roadmap and retire the dead PRD pointers - #305
Conversation
Recovery checkpoint only. The current issue body no longer matches the approved scope bound to the expired lease. Do not push, review, or merge this work until a fresh exact-body approval and lease are recorded.
The checkpoint added the roadmap page, the nav entry and most of the sweep. Two mentions of `docs/PRD.md` were still live in published pages, and they are not the same kind of thing: - `docs/adr/0053` §More information pointed a reader at "`docs/PRD.md` §12.5" as bare text, in a list whose neighbouring entry IS a link. The site excludes `PRD.md`, so that pointer goes nowhere. Now the absolute blob URL, and it says the site does not serve it. - `docs/agents/review.md` names `docs/PRD.md` in the list of paths whose edits are MATERIAL, beside `AGENTS.md` and `.agents/**`. That is a rule's operand, not a citation - rewriting it as a hyperlink would misrepresent a glob as a reference. Deliberately left. `mkdocs build --strict` cannot catch either: a bare mention is not a link, so nothing warns. That is why the sweep is now a test rather than a grep run once - it distinguishes the two forms, and pins both directions so the distinction cannot rot into "any mention passes". Also pins what the roadmap must answer, structurally rather than by wording: the three sections the issue specifies, and at least three explicit non-goals - a floor, since the exact count is editorial and the promise is the floor.
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Comment |
|
Diff declared final at Risk is @codex review The judgement call in this PR is the thing to attack:
Budget is in the PR body: 0.88× against |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 2b3b142398
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
… adjacent punctuation Codex's round-1 finding. The pattern allowed any mention followed by `,` or `)`, which ordinary prose satisfies - "Read `docs/PRD.md`, which documents the requirements." read as a scope list. So a real dead pointer sitting before a comma stayed invisible and the sweep stayed green while the criterion it enforces had regressed: the guard reporting nothing is exactly what makes it worse than no guard. Two conditions now, and both are needed. The comma-separated element holding the mention must be EXACTLY a backticked token, which rejects "Read `docs/PRD.md`"; and it must keep company with at least two more bare backticked tokens, which rejects a two-clause sentence whose first clause happens to be nothing but the path. Codex's counterexample is pinned verbatim, along with the parenthesised form and a one-companion case, and the real list is asserted with the mention in two different positions.
|
Round 1 answered at A guard that reports nothing while the criterion has regressed is worse than no guard: it turns Two conditions now, both load-bearing: the comma-separated element holding the mention must be A pilot observation worth more than the fix. This is the fourth rule in this session whose
In every case the first version was a pattern over syntax and the correct version was a check on No further review is requested. Round 1 of 2 is spent; this is the answer to it. |
Second PR of the swarm pilot, claimed through the mutex as
agent/issue-188, generation38511096735, held across both authoritative writes.What was already there
84147afis the inherited checkpoint (86c201d, 2026-07-26):docs/roadmap.md, its nav entry,the landing-page link, and most of the pointer sweep. The plan recorded it as having spent 91 of the
150-line budget.
What this claimant added
Two mentions of
docs/PRD.mdwere still live in published pages, and they are not the same kindof thing. That distinction is the whole of the work here.
docs/adr/0053§More information pointed a reader at "docs/PRD.md§12.5" as bare text — in alist whose neighbouring entry is a link.
mkdocs.ymlexcludesPRD.mdfrom the site, so thatpointer goes nowhere. Now the absolute blob URL, and it says outright that the site does not serve
it. ADR records build under
not_in_nav, so this was live on the published site.docs/agents/review.mdnamesdocs/PRD.mdin the list of paths whose edits are material,beside
AGENTS.md,docs/adr/**and.agents/**. That is a rule's operand, not a citation.Rewriting it as a hyperlink would misrepresent a glob as a reference. Deliberately left, and
the guard below encodes the distinction rather than special-casing the file.
mkdocs build --strictcannot catch either: a bare mention is not a link, so nothing warns. Thatis precisely why four pages accumulated dead pointers before #188 was filed — and why the sweep is
now a test instead of a grep run once. It pins both directions, so the distinction cannot rot
into "any mention passes".
It also pins what the roadmap must answer, structurally rather than by wording: the three sections
the issue specifies, and at least three explicit non-goals — a floor, since the exact count is
editorial and the floor is the promise.
Verified, not assumed
The roadmap claims
v1.0.0-rc1is the current public version. Checked against the repository:v1.0.0-rc1is the newest tag and a published pre-release (2026-07-21), and no stablev1.0.0exists. The claim is accurate.
Budget — measured, with both findings reported
size:S, budget 150 added lines.scope_guard.pyoutput:84147afthe checkpointmainOne advisory finding worth stating rather than leaving to the workflow: from the checkpoint base the
proportional-test rule fires — 130 test lines against a cap of 80, because
src_addedis 2 (thesingle ADR line) and the cap collapses to its floor. That rule is calibrated for code PRs; on a docs
PR whose deliverable is prose, "source lines" is close to meaningless. Reported, not worked around.
Verification
pytest tests/test_docs_prd_pointers.py tests/test_adr_index.py— 19 passedmkdocs build --strict— green, andsite/roadmap/index.htmlexistsgrep -rn 'docs/PRD.md' docs --include=*.md— 4 hits, 3 absolute blob URLs and 1 scope enumerationpre-commit run --all-files— greenclaim.py check --generation 38511096735—held: trueCloses: #188