plan: the docs count things by hand, and one of those counts is already wrong #1860

Merged
jaylouisw merged 1 commit from plan/1117-1510 into main 2026-11-17 15:17:11 +00:00
Owner

Forward plan only, no code. docs/plans/doc-counts.md.

The docs quote three kinds of numbers about the code - suite check counts, the show census, table sizes - and nothing measures any of them. Measured on d81e56dd:

  • 35 N checks claims (26 in docs/ARCHITECTURE.md); 28 name a test/*.test.js in the same sentence.
  • One is already stale: ARCHITECTURE.md:1108 says trunk-allowed-add-remove has 47 checks; it prints 57 (#1831 added ten).
  • docs/CLI.md:2339 quotes 54 forms, 108 commands, 66 refusals - docs-show-commands.test.js prints exactly those and asserts only a floor (:92, >= 40). The sentence was hand-rewritten in #1780, #1852 and #1854.
  • ARCHITECTURE.md:732 still says the twelve words one section after #1858 titled it thirteen, while engine/cli.js:394-408 holds 13 entries.

Steps: export tally() from scripts/run-tests.js (S) -> test/doc-counts.test.js with a paragraph-join matcher and a self-proving fixture (M) -> clear the two live defects (S) -> let docs-show-commands.test.js own its census (M). The two hard shapes ("Neighbours green", "reverting fails N") are deliberately deferred.

Closes no open issue; the queue is seven device requests. Does not overlap doc-citations.md (file:line drift).

Forward plan only, no code. `docs/plans/doc-counts.md`. The docs quote three kinds of numbers about the code - suite check counts, the `show` census, table sizes - and nothing measures any of them. Measured on `d81e56dd`: - 35 `N checks` claims (26 in `docs/ARCHITECTURE.md`); 28 name a `test/*.test.js` in the same sentence. - **One is already stale**: `ARCHITECTURE.md:1108` says `trunk-allowed-add-remove` has 47 checks; it prints 57 (#1831 added ten). - `docs/CLI.md:2339` quotes *54 forms, 108 commands, 66 refusals* - `docs-show-commands.test.js` prints exactly those and asserts only a floor (`:92`, `>= 40`). The sentence was hand-rewritten in #1780, #1852 and #1854. - `ARCHITECTURE.md:732` still says *the twelve words* one section after #1858 titled it thirteen, while `engine/cli.js:394-408` holds 13 entries. Steps: export `tally()` from `scripts/run-tests.js` (S) -> `test/doc-counts.test.js` with a paragraph-join matcher and a self-proving fixture (M) -> clear the two live defects (S) -> let `docs-show-commands.test.js` own its census (M). The two hard shapes ("Neighbours green", "reverting fails N") are deliberately deferred. Closes no open issue; the queue is seven device requests. Does not overlap `doc-citations.md` (file:line drift).
plan: the docs count things by hand, and one count is already wrong
All checks were successful
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 7s
CI / Classify the change (pull_request) Successful in 10s
CI / Server smoke test (pull_request) Successful in 8s
CI / Docker build (pull_request) Successful in 23s
CI / Test (Node 20) (pull_request) Successful in 47s
CI / Test (Node 18) (pull_request) Successful in 56s
CI / Test (Node 22) (pull_request) Successful in 52s
CI / Arm auto-merge (pull_request) Successful in 17s
51a9e8539a
Forward plan only, no code. Measures the census the docs quote by hand:
35 'N checks' claims (26 in ARCHITECTURE.md), 28 naming a suite, one
already stale (ARCHITECTURE.md:1108 says 47, the suite prints 57), and
docs/CLI.md:2339's 54 forms / 108 commands / 66 refusals rewritten by
hand three times in the last ten PRs. Also records the live twelve vs
thirteen contradiction left in ARCHITECTURE.md:732 by #1858.
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
jaylouisw/packetforge!1860
No description provided.