Skip to content

docs: comments and docs state facts, not internal process references - #35

Merged
Paullo9 merged 2 commits into
mainfrom
issue-18-docs-refs
Oct 29, 2026
Merged

Paullo9 merged 2 commits into
mainfrom
issue-18-docs-refs

Conversation

@Paullo9

@Paullo9 Paullo9 commented Oct 28, 2026

Copy link
Copy Markdown
Contributor

Requested by Paul

What and why

Comments and docs now state facts instead of citing material that is not in this repo. Fixes #18 together with the tools/ sweep, which is a commit on #33 (see below).

  • Sources and tests: the citations to docs/archive/v5, the registration and pre-registration notes, WP/lane ids, ADR 054/064, gate names and the maintainer-instructions file are gone. Each comment keeps the fact it relied on (the upstream function, the tolerance, the reason) or is deleted. Personal references (a named detector, "the owner's file 1339") are now neutral ("a measured Al-alloy map"). The S1 test-partition headers are removed.
  • Package.swift: the history is gone ("Measured in S3", "registration Q6", "S2's unsafe flag", the FormatoKit range history). It keeps what a reader of the manifest needs: the modules and their dependencies, why there is no Debug -O, and why there are no unsafe flags.
  • docs/status.md now describes 0.12.0. docs/open-items.md has items 1 to 11, with no second item 9, and no longer cites ../CLAUDE.md.
  • docs/design/eels-task-16.md becomes the design note docs/design/eels-chain.md, without the hand-off sections (scope and order, pin scripts, parity rows to move, tests, closeout). auto-id-tem.md loses its decision preamble, the artifact link and the review and closeout lines. Its method, code map, measured results and sources stay.
  • The only code change is the wording of the user-visible note ProposalRules.source: "fixed 2026-10-07, …" in place of "registered 2026-10-07 (WP4), …". The public names ProposalRules.registered/.shipped stay, since they are API.

Overlaps: tools/ is renamed and rewritten by #33, and #21 deletes the JSON code. To avoid conflicts, this PR leaves tools/ and the GOSTable JSON comment alone. The tools/ sweep is a commit on #33. docs/open-items.md item 4 and docs/parity.md line 7 change in the same way as in #30 and #33, so whichever merges second may need a one-line resolution.

Checklist

  • swift test -c release --parallel --skip SpectroKitParityTests passes, and the parity target compiles
  • No tolerance changed and no number moved
  • Docs updated
  • Nothing described as validated

🤖 Generated with Claude Code

Sources, tests, Package.swift and docs no longer cite the archived design and registration documents, work-package and
lane ids, ADR numbers, gate names or the maintainer-instructions file; each comment keeps the fact it relied on (the
upstream function, the tolerance, the reason) or goes. Personal references (a named detector, 'the owner's file') are
now neutral descriptions. Package.swift's comments say what a reader of the manifest needs. docs/status.md describes
0.12.0, docs/open-items.md has one item per number and cites nothing outside the repo, docs/design/eels-task-16.md is
the design note docs/design/eels-chain.md without the hand-off sections, and auto-id-tem.md loses its decision preamble.
No code changes except ProposalRules.source's wording ('fixed 2026-10-07, ...').

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Paullo9 Paullo9 self-assigned this Oct 28, 2026
@Paullo9
Paullo9 merged commit 5fb8710 into main Oct 29, 2026
8 checks passed
@Paullo9
Paullo9 deleted the issue-18-docs-refs branch October 29, 2026 07:50
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.

Comments and docs cite material that is not in this repo

1 participant