From da8e457e97e3e5394f7c4a900ff16e64d91e92f4 Mon Sep 17 00:00:00 2001 From: null Date: Mon, 17 Aug 2026 22:45:35 -0500 Subject: [PATCH] fix(docs): two documents claimed files that must not exist doc-claims.sh could not run on this tree until the previous commit, and its first run found both immediately. docs/data/README.md illustrated the wrong place to put an asset by naming `docs/data/logo.webp` in backticks. A backticked path is a claim the file exists, so the example of where NOT to put a file asserted that a file was there. Reworded to name the two directories instead, both of which exist. project-readme-template.md linked docs/architecture/Engineering_Reference_Manual.md, a document the template does not ship and most projects will never write. It now points at docs/architecture/README.md, which every scaffolded project has, and says to name a reference manual beside it once there is one. Left unfixed, every project adopting this template would inherit a red doc-claims from its first day, and a permanently red gate is one everybody learns to ignore -- audit-gate.mjs makes that argument at length about npm advisories, and it applies here. This is the third instance this session of one shape: a document that describes an absent or forbidden path becomes an assertion that it exists. The others were docs/planning/FUTURE.md in BATCH_LEDGER.md and an `Exempt:` line inside a code fence. Co-Authored-By: Claude Opus 5 (1M context) --- docs/data/README.md | 4 ++-- project-readme-template.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/data/README.md b/docs/data/README.md index b183607..89efddc 100644 --- a/docs/data/README.md +++ b/docs/data/README.md @@ -18,8 +18,8 @@ docs/data/img/logo.webp the full lockup, used on the project page docs/data/img/banner.webp the wide image, used across the project header ``` -All **webp**. All **required**. Only `img/` is checked — an asset left at -`docs/data/logo.webp` is not found. +All **webp**. All **required**. Only `img/` is checked — an asset left in +`docs/data/` instead of `docs/data/img/` is not found. **Dimensions, weights and how to generate them are in [`img/README.md`](img/README.md)**, beside the files they describe. This diff --git a/project-readme-template.md b/project-readme-template.md index 8168fa8..9c7f9ff 100644 --- a/project-readme-template.md +++ b/project-readme-template.md @@ -167,7 +167,7 @@ procedures belong in docs, and open work belongs in the tracker. | --- | --- | | [docs/DOC_TRUST_MAP.md](docs/DOC_TRUST_MAP.md) | Which document owns which answer, and which source wins when records disagree. | | [docs/WORK_CYCLE.md](docs/WORK_CYCLE.md) | What happens at the end of a piece of work: closing issues and milestones, recording next action and blockers, and what privacyllc.dev will and will not update on its own. | -| [docs/architecture/Engineering_Reference_Manual.md](docs/architecture/Engineering_Reference_Manual.md) | Architecture, data model, and engineering rules. | +| [docs/architecture/README.md](docs/architecture/README.md) | Architecture, data model, and engineering rules. Name a reference manual beside it once the project has one. | | [docs/security/SECURITY.md](docs/security/SECURITY.md) | Threat model and security posture. | ## Agent Notes