Skip to content

docs: finish cannibalising the retired docs repo - #6

Merged
MatejGomboc merged 2 commits into
mainfrom
docs/style-spelling-exceptions
Jul 30, 2026
Merged

docs: finish cannibalising the retired docs repo#6
MatejGomboc merged 2 commits into
mainfrom
docs/style-spelling-exceptions

Conversation

@MatejGomboc

@MatejGomboc MatejGomboc commented Jul 30, 2026

Copy link
Copy Markdown
Member

Summary

You asked me to double-check nothing useful was discarded from the retired setonix-os/docs repo. I re-audited exhaustively β€” file-by-file (config, tables and the PR template included, which the earlier prose-only shingle diff had skipped) and git-history for provenance.

Provenance: all 11 docs commits are ancestry of main except the retirement-banner commit, which correctly stays only in the retired repo. No history lost.

Content: three genuine omissions found and folded here; the constitution itself was verified to have zero dropped clauses (every docs-only line was reworded-in-place or superseded by newer kernel text):

  1. PR template β€” gains an If this changes a document or the constitution section carrying the amendment guidance the docs repo's template had and the code-first kernel one lacked (state what it supersedes/invalidates, no stale clause, no renumbering of cited sections). Bonus: its CLAUDE.md references β€” stale since the rename β€” are all corrected to CONSTITUTION.md.
  2. .gitignore β€” book/ and _site/, the mdBook/Pages render output RFC-0002 commits to at Phase 4.
  3. .gitattributes β€” *.pdf binary.

Also still includes the original commit of this PR: restoring the British-spelling exceptions list to STYLE.md.

Everything else the audit surfaced was reworded-in-place, superseded, or docs-repo-specific framing. The retired repo now holds nothing of substance absent here.

Which pillar does this serve?

None β€” documentation completeness toil (Β§5.3).

unsafe register

  • New unsafe blocks: None

Checklist

  • British spelling clean, markdown lint-clean
  • docs/CHANGELOG.md updated
  • Commits GPG-signed
  • Docs/config only β€” no Rust touched

πŸ€– Generated with Claude Code

MatejGomboc and others added 2 commits July 30, 2026 18:01
The final gap from a phrase-level audit of the retired docs repository: its
STYLE enumerated the spelling exceptions, and the fold into this repo's
STYLE kept only the code-identifier one. The dropped items β€” quoted text,
proper nouns, and LICENCE / CODE_OF_CONDUCT excluded as legal and upstream
text β€” are exactly what check-british-spelling.sh already excludes, so the
document was under-describing its own enforced tool. Restored, and tied to
the script's ALLOWED_PATTERNS so the two cannot drift.

With this, the retired docs repository is fully cannibalised: a shingle
diff of every prose file against the whole kernel tree now shows nothing of
substance present there and absent here.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
An exhaustive re-audit (file-by-file plus git-history, not just the earlier
prose shingle diff) found three genuine omissions the shingle pass had
skipped because it ignored config files, tables, and the PR template. All
now folded; with these the retired repository holds nothing of substance
that is absent here.

  - PR template gains "If this changes a document or the constitution": the
    amendment guidance the docs repo's own template carried and the
    code-first kernel template lacked β€” state what an amendment supersedes
    and invalidates, leave no stale clause, renumber no cited section, log
    it in the changelog. Bonus fix in the same file: its CLAUDE.md section
    references, stale since the CONSTITUTION.md rename, are all corrected.
  - .gitignore ignores book/ and _site/ β€” the mdBook / Pages render output
    RFC-0002 commits to at Phase 4, so a first local render cannot be
    committed by accident.
  - .gitattributes marks *.pdf binary.

Provenance was verified too: all eleven docs-repo commits are ancestry of
main except the retirement-banner commit, which correctly lives only in the
retired repo. Nothing was discarded.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@MatejGomboc MatejGomboc changed the title docs(style): restore the British-spelling exceptions list docs: finish cannibalising the retired docs repo Jul 30, 2026
@MatejGomboc
MatejGomboc merged commit f7dba01 into main Jul 30, 2026
6 checks passed
@MatejGomboc
MatejGomboc deleted the docs/style-spelling-exceptions branch July 30, 2026 16:46
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