docs(simulation): the claims audit printed counts its own commands contradict #1914

Merged
jaylouisw merged 1 commit from docs/1117-2316 into main 2026-11-17 23:21:45 +00:00
Owner

docs/SIMULATION.md �11 exists to stop the other pages overstating the code. Two of the counts it states had themselves gone stale, and the page prints the commands that contradict them.

What was untrue

  • 2,348 models across 258 vendors � the catalogue command printed two lines below it now answers models 2351 vendors 258 categories 25, and node scripts/regen-registry-doc.js --check says "The catalogue pages are current: 2,351 models across 258 vendors". �1 of the same page (the firewall row, fixed today in #1912) already said 2,351, so the page contradicted itself as well as the tree.
  • eighteen mechanisms today � test/help-completeness.test.js enumerates nineteen and prints 19 mechanisms are all implemented, all in help, and all in docs/CLI.md``. ip routing (#1869) is the mechanism the sentence did not count.

Evidence

$ node -e "const {loadCatalog}=require(./devices/registry);const s=loadCatalog(./devices).filter(x=>!x.error);console.log(models,s.length,vendors,new Set(s.map(x=>x.vendor)).size,categories,new Set(s.map(x=>x.category)).size)"
models 2351 vendors 258 categories 25
$ node scripts/regen-registry-doc.js --check
The catalogue pages are current: 2,351 models across 258 vendors, 29,261 sockets, 968 distinct port shapes.
$ node test/help-completeness.test.js | tail -3
  ? 19 mechanisms are all implemented, all in `help`, and all in docs/CLI.md
  ? 16 `show` commands are all in the documented command table
  8 passed, 0 failed

Why it drifted unguarded: test/doc-catalog-counts.test.js asserts the catalogue counts in the generated pages (DEVICE_REGISTRY, README, CONNECTORS, wiki) and reads no line of SIMULATION.md; help-completeness reads docs/CLI.md only. The page is hand-written prose about measured code, so nothing was watching the two numbers it tells the reader to trust.

Docs only � no engine, test or workflow change. Guards before and after are identical (nothing reads these lines yet).

`docs/SIMULATION.md` �11 exists to stop the other pages overstating the code. Two of the counts it states had themselves gone stale, and the page prints the commands that contradict them. **What was untrue** * `2,348 models across 258 vendors` � the catalogue command printed two lines below it now answers `models 2351 vendors 258 categories 25`, and `node scripts/regen-registry-doc.js --check` says "The catalogue pages are current: 2,351 models across 258 vendors". �1 of the same page (the firewall row, fixed today in #1912) already said 2,351, so the page contradicted itself as well as the tree. * `eighteen mechanisms today` � `test/help-completeness.test.js` enumerates nineteen and prints `19 mechanisms are all implemented, all in `help`, and all in `docs/CLI.md``. `ip routing` (#1869) is the mechanism the sentence did not count. **Evidence** ``` $ node -e "const {loadCatalog}=require(./devices/registry);const s=loadCatalog(./devices).filter(x=>!x.error);console.log(models,s.length,vendors,new Set(s.map(x=>x.vendor)).size,categories,new Set(s.map(x=>x.category)).size)" models 2351 vendors 258 categories 25 $ node scripts/regen-registry-doc.js --check The catalogue pages are current: 2,351 models across 258 vendors, 29,261 sockets, 968 distinct port shapes. $ node test/help-completeness.test.js | tail -3 ? 19 mechanisms are all implemented, all in `help`, and all in docs/CLI.md ? 16 `show` commands are all in the documented command table 8 passed, 0 failed ``` **Why it drifted unguarded**: `test/doc-catalog-counts.test.js` asserts the catalogue counts in the *generated* pages (DEVICE_REGISTRY, README, CONNECTORS, wiki) and reads no line of SIMULATION.md; `help-completeness` reads `docs/CLI.md` only. The page is hand-written prose about measured code, so nothing was watching the two numbers it tells the reader to trust. Docs only � no engine, test or workflow change. Guards before and after are identical (nothing reads these lines yet).
docs(simulation): the claims audit printed counts its own commands contradict
All checks were successful
CI / Classify the change (pull_request) Successful in 10s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 11s
CI / Server smoke test (pull_request) Has been skipped
CI / Docker build (pull_request) Has been skipped
CI / Test (Node 20) (pull_request) Successful in 47s
CI / Test (Node 22) (pull_request) Successful in 52s
CI / Test (Node 18) (pull_request) Successful in 57s
CI / Arm auto-merge (pull_request) Successful in 22s
d8ab68866e
`docs/SIMULATION.md` §11 tells the reader to measure the tree rather than trust a
number, prints the two commands that do it, and then stated two counts neither
command has produced for several merges:

* **2,348 models across 258 vendors** -> the page's own catalogue command now
  prints `models 2351 vendors 258 categories 25`, and `node
  scripts/regen-registry-doc.js --check` agrees ("2,351 models across 258
  vendors"). §1 of the same page already said 2,351, so the page contradicted
  itself as well as the tree.
* **eighteen mechanisms today** -> `test/help-completeness.test.js` enumerates
  nineteen and prints "19 mechanisms are all implemented"; `ip routing` (#1869)
  is the addition the sentence did not count.

Both were unguarded: `test/doc-catalog-counts.test.js` checks the generated
catalogue pages (registry, README, CONNECTORS, wiki) but reads no line of this
page, and `help-completeness` reads `docs/CLI.md` only. Numbers are now the ones
the code states, and the mechanism count says where it comes from.
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!1914
No description provided.