docs: this repo is public, so say what things are, not who decided them

Comments and served API descriptions here had grown references that only make
sense to someone with our internal notes: relative paths that escape this
tree, filenames and titles of documents nobody outside can open, quoted prose
from them, and the name of a component that has no public surface — once in an
OpenAPI description, which is published output rather than source.

None of it was load-bearing. Every case restates as what the code actually
requires, and every rewrite came out shorter: "in the words the host agent
reports" for a component name, "republished as addresses are discovered" for a
quoted phrase, "a size tier sets vCPU, RAM and the output geometry" for a
sentence that had been carrying a path.

Internal reasoning is now cited exactly one way, ref(d-NNNN) in a source
comment, with the rule that the sentence must still stand if the marker is
deleted. CLAUDE.md leads with it, because the previous version of this mistake
was made by people who knew the repo was public and it still took ten
occurrences to notice, so "be careful" is not a mechanism.

Commit messages get the stricter rule and carry no references at all: a
comment can be fixed by the next commit and a published message cannot be
fixed at all. Git hooks now enforce both halves.

The check caught a real one while being written: the CLAUDE.md table spelled
out the paths it was prohibiting, which discloses them to exactly the reader
it protects against.

138 tests, 0 fail.
This commit is contained in:
Wanjohi
2026-09-03 22:16:47 +03:00
parent c3682136f1
commit cf56aaf04c
21 changed files with 159 additions and 112 deletions

View File

@@ -1,5 +1,5 @@
-- 0048: a box is a row, a session is the billing unit, and hardware belongs to
-- exactly one team.
-- A box is a row, a session is the billing unit, and hardware belongs to
-- exactly one team. ref(d-0048)
--
-- Three of the five changes here touch live rows, and the generated form of
-- this migration would have failed on all three:
@@ -105,7 +105,7 @@ WHERE m."team_id" IS NULL;--> statement-breakpoint
--
-- This is the only destructive statement in the migration and it is a
-- considered loss: `game_download` is a progress report a host writes about
-- itself, and `neslet` re-derives it from what is on disk. A row that survives
-- itself, and the host re-derives it from what is on disk. A row that survives
-- here is one whose host we can actually name; one that does not was
-- unattributable, which is exactly the bug the foreign key exists to prevent.
DELETE FROM "game_download" d