null
/
Project-Template
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

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) <noreply@anthropic.com>
This commit is contained in:
null 2026-08-17 22:45:35 -05:00
parent 6965915dbd
commit da8e457e97
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/data/README.md
View File

@ -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 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 All **webp**. All **required**. Only `img/` is checked — an asset left in
`docs/data/logo.webp` is not found. `docs/data/` instead of `docs/data/img/` is not found.
**Dimensions, weights and how to generate them are in **Dimensions, weights and how to generate them are in
[`img/README.md`](img/README.md)**, beside the files they describe. This [`img/README.md`](img/README.md)**, beside the files they describe. This

2
project-readme-template.md
View File

@ -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/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/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. | | [docs/security/SECURITY.md](docs/security/SECURITY.md) | Threat model and security posture. |
## Agent Notes ## Agent Notes