docs: the catalogue holds 2,188 models, not 2,167 #1637

Merged
jaylouisw merged 1 commit from docs/1116-0845 into main 2026-11-16 08:50:30 +00:00
Owner

Two hand-written copies of the catalogue count had drifted from the catalogue.

What was untrue

  • README.md:85 � "2,167 models across 252 vendors" (the vendor count is still right; the model count is not).
  • docs/CONNECTORS.md:1018 � "2,167 models built from 857 distinct port shapes".
  • docs/CONNECTORS.md:1025 � a pasted transcript, "(2167 models, 24338 sockets, 857 distinct port shapes)", which is the output of test/faceplate-catalogue.test.js and cannot be reproduced at this tree.

Evidence from the code

node -e "require(./devices/registry).loadCatalog(devices)"  ->  2188 entries, 0 errors, 252 vendors
node test/faceplate-catalogue.test.js  ->  (2188 models, 24679 sockets, 867 distinct port shapes)

docs/DEVICE_REGISTRY.md already reads 2,188 � it is regenerated from the catalogue by scripts/regen-registry-doc.js and guarded by test/doc-catalog-counts.test.js. The two hand-written copies are the ones nothing recomputes, which is why they drifted while the registry page stayed current.

Scope

Docs only: three numbers in two files. The transcript now matches the command output character for character. No code, no test, no behaviour change � the gap that lets this recur (README and CONNECTORS numbers are not recomputed by any script) is left for a separate change.

Gates

  • node scripts/syntax-check.js � 345 files, all OK
  • check-control-bytes.js � clean; check-canonical-urls.js � 2,784 files OK
  • docs-show-commands 7/7, help-completeness 8/8, doc-catalog-counts 24/24, faceplate-catalogue 14/14 (unchanged before and after)
Two hand-written copies of the catalogue count had drifted from the catalogue. **What was untrue** - `README.md:85` � "**2,167 models across 252 vendors**" (the vendor count is still right; the model count is not). - `docs/CONNECTORS.md:1018` � "**2,167 models built from 857 distinct port shapes**". - `docs/CONNECTORS.md:1025` � a pasted transcript, "(2167 models, 24338 sockets, 857 distinct port shapes)", which is the output of `test/faceplate-catalogue.test.js` and cannot be reproduced at this tree. **Evidence from the code** ``` node -e "require(./devices/registry).loadCatalog(devices)" -> 2188 entries, 0 errors, 252 vendors node test/faceplate-catalogue.test.js -> (2188 models, 24679 sockets, 867 distinct port shapes) ``` `docs/DEVICE_REGISTRY.md` already reads 2,188 � it is regenerated from the catalogue by `scripts/regen-registry-doc.js` and guarded by `test/doc-catalog-counts.test.js`. The two hand-written copies are the ones nothing recomputes, which is why they drifted while the registry page stayed current. **Scope** Docs only: three numbers in two files. The transcript now matches the command output character for character. No code, no test, no behaviour change � the gap that lets this recur (README and CONNECTORS numbers are not recomputed by any script) is left for a separate change. **Gates** - `node scripts/syntax-check.js` � 345 files, all OK - `check-control-bytes.js` � clean; `check-canonical-urls.js` � 2,784 files OK - `docs-show-commands` 7/7, `help-completeness` 8/8, `doc-catalog-counts` 24/24, `faceplate-catalogue` 14/14 (unchanged before and after)
docs: the catalogue holds 2,188 models, not 2,167
All checks were successful
CI / Classify the change (pull_request) Successful in 14s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 18s
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 1m21s
CI / Test (Node 18) (pull_request) Successful in 1m34s
CI / Test (Node 22) (pull_request) Successful in 1m37s
2e3c2fe93c
README.md and docs/CONNECTORS.md both still quoted 2,167 models, and the
faceplate transcript in CONNECTORS.md quoted "(2167 models, 24338 sockets,
857 distinct port shapes)" — a line that cannot be reproduced by running
test/faceplate-catalogue.test.js at this tree.

Evidence, from the code:
  loadCatalog('devices') -> 2188 entries, 0 errors, 252 vendors
  node test/faceplate-catalogue.test.js -> (2188 models, 24679 sockets, 867 distinct port shapes)

docs/DEVICE_REGISTRY.md already says 2,188 (it is regenerated from the
catalogue); only these two hand-written copies had drifted.
jaylouisw scheduled this pull request to auto merge when all checks succeed 2026-11-16 08:50:21 +00:00
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!1637
No description provided.