Skip to content

Removes planning references from provenance lines - #233

Merged
johnnyt merged 1 commit into
mainfrom
px-bpgr-scrub-docs-provenance
Sep 25, 2026
Merged

johnnyt merged 1 commit into
mainfrom
px-bpgr-scrub-docs-provenance

Conversation

@johnnyt

@johnnyt johnnyt commented Sep 25, 2026

Copy link
Copy Markdown
Member

Removes references to the maintainers' private planning work from this repo's public docs, for px-bpgr. Words only: no code, behaviour, record status or version changes.

What changed

  • CLAUDE.md: the two "(Recorded by the operator, ...)" provenance lines in the authority section keep their date and "by the operator" and lose the planning reference. One of the two references was split across a line break, which a line-by-line scan misses. The authority rows are unchanged.
  • docs/adr/0016-predicator-emits-no-telemetry.md (accepted): the Status line keeps its date and verdict and loses the planning reference.
  • docs/adr/0017-structured-authoring-is-a-subset-value.md (accepted): the Status line keeps both dates; the two decision headings lose a trailing planning label; the dated Note on acceptance keeps "the maintainer's grant accepted this record on 2026-09-05".
  • .claude/firewall-allow.txt (new): lists the exact strings that cite this repo's own numbered lists, grouped by file with the reason in its header. The R-numbered strings are the five check-step rules that conformance/RATCHET.md defines, plus the lines in conformance/, docs/, and a test/ file that cite them. The Q-numbered strings are the open questions that plans and research documents under docs/ number for themselves, plus the lib/ comments that cite them. Each entry covers only the few words around one match.

No changelog fragment: changelog.d/README.md excludes documentation, and no rendered doc changes meaning.

Records under the scrub

Only provenance wording changed in each record touched, docs/adr/0016-predicator-emits-no-telemetry.md and docs/adr/0017-structured-authoring-is-a-subset-value.md. git diff --word-diff origin/main -- docs/adr/ shows only removed planning references: no other word is added or removed, no decision changes, and no Note or Status is added. The dated notes rule in docs/adr/README.md is set aside only for this provenance edit, under the maintainers' consent. It is not an amendment.

Review (in-turn)

I re-read the diff against the bead and its dated note. Every edited sentence still says what it said, minus the reference. The two headings still name the same decisions. The acceptance Note still dates the acceptance and names who accepted. The two CLAUDE.md lines still record the same exceptions, on the same dates, by the operator. I checked the allowlist entries against the definitions they cover: conformance/RATCHET.md defines the five check-step rules, and each plan or research document that uses a Q-number numbers its own questions. Acceptance, machine-checked: the planning-reference scan passes on every file the scan hit on main, and the outbound diff scan is clean. Tier: gate. No contract surface is touched, only CLAUDE.md, two records and one new scan allowlist changed, and no code file changed.

Gate

Full gate mix quality green on the committed tree: format, compile, doc links, dependencies, credo, docs, tests and dialyzer. The terminology firewall scan and its constructed positive control ran on the outbound diff, the commit message and this body.

Two authority provenance lines in CLAUDE.md and the status lines,
two decision headings and one note of ADR-0016 and ADR-0017 named the
maintainers' private planning work by number. Each reference is
removed in place; the dates and the operator stay, and no decision,
authority row or record status changes.

Adds .claude/firewall-allow.txt listing, as exact strings, the lines
that cite this repo's own numbered lists: the five check-step rules
conformance/RATCHET.md defines, and the open questions the plans and
research documents under docs/ number for themselves. No code,
behaviour or version change; no changelog fragment, since
changelog.d/README.md excludes documentation.

Refs: px-bpgr
@johnnyt
johnnyt merged commit 4eeb123 into main Sep 25, 2026
1 check passed
@johnnyt
johnnyt deleted the px-bpgr-scrub-docs-provenance branch September 25, 2026 08:10
@codecov

codecov Bot commented Sep 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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