docs(readme): drop the docs/ file count, which was true once and cannot stay true - #888
Open
wshallwshall wants to merge 1 commit into
Open
docs(readme): drop the docs/ file count, which was true once and cannot stay true#888wshallwshall wants to merge 1 commit into
wshallwshall wants to merge 1 commit into
Conversation
…ot stay true docs/README.md opened with "There are **377 markdown files** under `docs/`". A plain `find docs -name "*.md" | wc -l` returns 285. 377 was correct the day it was written and has never been updated since. The index was added by dc3a763 on 2026-07-31, and its parent 304a93b carries exactly 377 markdown files under docs/. The author counted the tree before adding the index, so the claim shipped off by the one file being written. The count does not drift slowly, it steps. Measured through the GitHub API at each of the six commits that have touched this file: 304a93b 2026-07-31 377 (parent; the number that was written) dc3a763 2026-07-31 378 fdec72c 2026-08-06 412 123d08b 2026-08-06 311 921db74 2026-09-01 280 b9f4f38 2026-09-04 285 The tree lost about a hundred markdown files between 2026-08-06 and 2026-09-01. Two of those six commits are ADR 0160 untracking passes, which move maintainer material out of this tree and into the vault clone. Two hypotheses for the gap were checked, and both fail. The primary checkout holds zero untracked or gitignored .md under docs/, so 377 did not count vaulted files that a plain find cannot see. The vault clone holds 585 .md under docs/, which is not a 92-file top-up either. So the sentence carries no number, and no test pins one. A pinned count would assert a figure whose meaning depends on which checkout reads it, inside a file whose next paragraph says docs/ is deliberately partial. The sentence's job is to tell a reader that most of docs/ is maintainer planning history, and that the index exists so they need not guess which is which. That survives intact. Deliberately not touched: docs/BACKLOG.md line 6912 records "347 markdown files" as part of a dated re-measurement inside a shipped item. A dated measurement says when it was true, so it is a record rather than a claim that rots. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
docs/README.mdline 3 opened with "There are 377 markdown files underdocs/". The realcount is 285. The sentence now carries no number.
Where 377 came from
It was correct the day it was written, and has never been updated.
dc3a7630badded the index on2026-07-31; its parent
304a93b85carries exactly 377 markdown files underdocs/. The authorcounted the tree before adding the index, so the claim shipped off by the one file being written.
The count steps rather than drifts. Measured through the GitHub API at each of the six commits that
have touched this file:
docs/**/*.md304a93b85dc3a7630bfdec72cac123d08b65921db74a1b9f4f3810The tree lost about a hundred markdown files between 2026-08-06 and 2026-09-01. Two of those six
commits are ADR 0160 untracking passes, which move maintainer material into the vault clone.
Two hypotheses were checked and both fail. The primary checkout holds zero untracked or
gitignored
.mdunderdocs/, so 377 did not count vaulted files a plainfindcannot see. Thevault clone holds 585
.mdunderdocs/, which is not a 92-file top-up either.Why no number and no pinning test
A pinned count would assert a figure whose meaning depends on which checkout reads it, inside a
file whose very next paragraph says
docs/is deliberately partial. The sentence's job is to tella reader that most of
docs/is maintainer planning history and that the index exists so they neednot guess which is which. That survives without a count.
Deliberately not touched:
docs/BACKLOG.mdline 6912 records "347 markdown files" as part of adated re-measurement inside a shipped item. A dated measurement says when it was true, so it is a
record rather than a claim that rots. No ledger row is needed for this change and none is added, so
this does not contend with the nine open PRs queued against
BACKLOG.md.Checks
Run locally, all green:
pre-commit run --files docs/README.md-- ledger gate, forbidden-content, control characters,username-as-access-key, gitleaks all Passed; the Python and workflow hooks skipped, no such files.
python scripts/docs/link_check.py docs-- 4847 relative links across 285 markdown files, everyone resolves.
pytest tests/test_dangling_citation_check.py tests/test_link_resolution.py tests/test_ech_record_premise.py-- 75 passed.pytest tests/test_private_paths_stay_ignored.py-- 35 passed (it is the only test file thatmentions
docs/README.md, in comments about the "Start here" section, which is untouched).Not run, and not applicable:
ruff,mypy, and the rest ofpytest. No Python changed.One instrument note for a reviewer repeating this:
link_check.py docs/README.mdreports0 relative links in 0 markdown filesand exits 0. It takes a directory, so the file form is afalse green. The run above passes
docs.Full history is not reachable from a local clone here -- this worktree and the primary are both
depth-1 shallow, where
git log -Sand--diff-filter=Aname the single commit for every stringand every file. The table above came from the GitHub API instead.
Co-Authored-By: Claude Opus 5 noreply@anthropic.com
🤖 Generated with Claude Code