Skip to content

Removes private planning references from docs, records and mix.exs - #170

Merged
johnnyt merged 1 commit into
mainfrom
sui-naph-scrub-docs-provenance
Sep 25, 2026
Merged

johnnyt merged 1 commit into
mainfrom
sui-naph-scrub-docs-provenance

Conversation

@johnnyt

@johnnyt johnnyt commented Sep 25, 2026 •

Copy link
Copy Markdown
Member

Summary

Removes the maintainers' private planning references (campaign numbers, walk and ruling references) from this repository's docs, records, CLAUDE.md and one mix.exs comment, in place. Bead: sui-naph.

  • Provenance that carried a reference now keeps the date and the operator and drops the reference (for example "(Recorded 2026-09-05 by the operator.)" and "accepted (2026-09-05; proposed 2026-09-02)").
  • A grant named by a reference now reads "the operator's grant".
  • A named ruling now reads as ruled by the operator; in docs/adr/0016-value-location-omits-its-fallback.md the ruling carries 2026-09-05, the date of the amendment it rules on, stated in the record's own header.
  • The mix.exs comment above the statifier_datamodel dependency keeps its reason ("the Hex floor, not a git pin") and drops the reference.

No code, no runtime string and no behaviour changes. No version bump. No changelog fragment: changelog.d/README.md excludes documentation. CHANGELOG.md is untouched.

Records touched (provenance wording only)

Each record file below changes provenance wording only: a Status or Amendment-status parenthetical, a dated Note's opening parenthetical, or a "Filed with" line. No decision, status word, clause or citation moves, and no record is flipped. A word diff against main shows only reference-to-neutral-wording swaps.

  • docs/adr/0003-fixtures-as-the-example-data-contract.md - Amendment status line.
  • docs/adr/0005-language-neutral-trace-wire-format.md - Amendment status line.
  • docs/adr/0007-text-first-authoring.md - both Amendment status lines.
  • docs/adr/0009-javascript-ships-as-source.md - three "Filed with" lines under dated notes.
  • docs/adr/0012-trace-projection-and-redaction.md - Amendment status line, the amendment's accepted line, the second Status line.
  • docs/adr/0013-otel-correlation-in-the-wire-format.md - Status line; the sentence naming the 2026-09-01 operator ruling (now "The operator ruling of 2026-09-01 (recorded as a dated note on sui-b94)").
  • docs/adr/0014-non-value-error-reasons-on-the-wire.md - Status line, one dated history entry.
  • docs/adr/0015-a-neutral-discriminator-for-exit-reasons.md - Status line, two dated history entries.
  • docs/adr/0016-value-location-omits-its-fallback.md - Status and Amendment status lines, two dated Notes, the ruling reference in one Note.
  • docs/adr/0017-an-offline-producer-for-the-wire-format.md - Status line, one dated Note.
  • docs/adr/0018-a-wire-message-for-guard-evaluation.md - Status line, three dated Notes.

Other files: CLAUDE.md (three "Recorded ... by the operator" provenance lines in the authority section; the rows' meaning is unchanged), docs/telemetry.md (Status line), docs/plans/260905-sui-2vj-path-types-declared-kinds.md (two bead lines and one "ruled" sentence), mix.exs (one comment).

Review (in-turn, tier=gate)

I re-read the diff against the bead and its dated note: the scope is docs/, README, CHANGELOG, changelog.d/, guides/, CLAUDE.md, AGENTS.md, and mix.exs by the note. Every edited sentence still says what it said, minus the reference. The ADR edits were checked with a word diff: only provenance wording changes. CLAUDE.md's record rule asks for "zero removed lines in the record"; a provenance swap in place removes lines by construction, and the operator's grant for this scrub permits provenance-only edits to records. The planning-reference scan of every file in scope reports no hit, and no repository-owned numbered list needed an allowlist entry, so no .claude/firewall-allow.txt is added. The tier is gate: no public function, module, option, wire shape or corpus expectation changes, and the diff is well under 300 lines.

Provenance

  • The bead's dated note widened the scope to mix.exs (one comment); a mix.exs edit is code by the gate, so the full gate ran.
  • Two references were wrapped across a line break and did not show in a line-by-line search: one in CLAUDE.md, one in docs/adr/0009-javascript-ships-as-source.md. A third, a bare number naming a planning walk in docs/plans/260905-sui-2vj-path-types-declared-kinds.md, now reads "The operator ruled that". All three are removed here.

Gate

mix quality green on the committed tree: every stage passed (Format, Compile, Doc links, Dependencies, Doctor, Credo, Docs, Tests, Dialyzer); Gettext and Sobelow skipped as not installed.

The maintainers' private planning references (campaign numbers, walk
and ruling references) do not belong in this public repository. Each
one in CLAUDE.md, docs/ and a mix.exs comment is removed in place:
where it recorded provenance, the date and the operator stay and the
reference goes; where it named a ruling, the text now says the
operator ruled it.

The edits inside docs/adr/ change provenance wording only: no
decision, status or clause moves, and no record is flipped. No code,
no runtime string and no behaviour changes; the mix.exs edit is a
comment. No version bump; no changelog fragment (changelog.d/README.md
excludes documentation).

Refs: sui-naph
@johnnyt
johnnyt merged commit 72b2535 into main Sep 25, 2026
1 check passed
@johnnyt
johnnyt deleted the sui-naph-scrub-docs-provenance branch September 25, 2026 08:00
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