docs(simulation): §11 stale rows quoted the README and CLI.md for text they no longer contain #1792

Merged
jaylouisw merged 2 commits from docs/1117-0445 into main 2026-11-17 04:56:00 +00:00
Owner

What was untrue

docs/SIMULATION.md §11 ("Where the other docs overstate the code") carried rows that no longer describe the tree:

row said measured
README.md:84 - "53 media types across eight families and 18 connector cages", engine at 65 media README prints 90 media types, ten families, 28 cages - and that is right: MEDIA = 90, CAGES = 28, families = 10
README.md:80 - "91 models / 17 vendors", catalogue at 905 specs / 199 vendors catalogue loads 2,344 specs / 258 vendors / 25 categories, which is what the README now prints
docs/CLI.md:50 - ip address dhcp "(reserved)", "nothing reads it" engine/cli.js _ifaceMode() sets iface.dhcp, displaces and names the static address, and prints the method in show running-config; CLI.md documents the one-method rule
docs/ARCHITECTURE.md:41 quoting dhcp-server as reserved, "dhcp-* still inert" the reserved row is line 42 and no longer lists dhcp; DHCP is live in the data path (#1051)
docs/ROADMAP.md:7-19, "except RIP, DHCP-in-the-data-path and wireless association" DHCP is in the data path - §5.1 of this same page says so; only RIP and the wireless RF medium are absent

What changed

  • README rows now cite the feature headings instead of line numbers (the numbers move; the heading does not).
  • ARCHITECTURE rows point at the line that exists (42) and at routeTo/routeDistance rather than device.js:364-443.
  • The ROADMAP exception list drops DHCP.
  • Four rows recorded as having left the table, with the two commands that re-measure the counts (they print media 90 cages 28 families 10 and models 2344 vendors 258 categories 25 at this commit).

Guards

  • node scripts/syntax-check.js - 374 files, all OK
  • node scripts/check-control-bytes.js - clean
  • docs-cli-transcript 4/4, docs-show-commands 7/7, help-completeness 8/8, no-form-help-key 81/81 (unchanged; none reads SIMULATION.md)
  • doc-citations 11/11, document-stamp 31/31, doc-catalog-counts 43/43

Docs-only: no engine change.

## What was untrue `docs/SIMULATION.md` §11 ("Where the other docs overstate the code") carried rows that no longer describe the tree: | row said | measured | |---|---| | `README.md:84` - "53 media types across eight families and 18 connector cages", engine at **65** media | README prints **90** media types, **ten** families, **28** cages - and that is right: `MEDIA` = 90, `CAGES` = 28, families = 10 | | `README.md:80` - "91 models / 17 vendors", catalogue at **905** specs / **199** vendors | catalogue loads **2,344** specs / **258** vendors / **25** categories, which is what the README now prints | | `docs/CLI.md:50` - `ip address dhcp` "(reserved)", "nothing reads it" | `engine/cli.js` `_ifaceMode()` sets `iface.dhcp`, displaces and names the static address, and prints the method in `show running-config`; CLI.md documents the one-method rule | | `docs/ARCHITECTURE.md:41` quoting `dhcp-server` as reserved, "`dhcp-*` still inert" | the reserved row is line **42** and no longer lists dhcp; DHCP is live in the data path (#1051) | | `docs/ROADMAP.md:7-19`, "except RIP, DHCP-in-the-data-path and wireless association" | DHCP **is** in the data path - §5.1 of this same page says so; only RIP and the wireless RF medium are absent | ## What changed - README rows now cite the feature headings instead of line numbers (the numbers move; the heading does not). - ARCHITECTURE rows point at the line that exists (42) and at `routeTo`/`routeDistance` rather than `device.js:364-443`. - The ROADMAP exception list drops DHCP. - Four rows recorded as having left the table, with the two commands that re-measure the counts (they print `media 90 cages 28 families 10` and `models 2344 vendors 258 categories 25` at this commit). ## Guards - `node scripts/syntax-check.js` - 374 files, all OK - `node scripts/check-control-bytes.js` - clean - docs-cli-transcript 4/4, docs-show-commands 7/7, help-completeness 8/8, no-form-help-key 81/81 (unchanged; none reads SIMULATION.md) - doc-citations 11/11, document-stamp 31/31, doc-catalog-counts 43/43 Docs-only: no engine change.
docs(simulation): §11's stale rows quoted text the README and CLI.md no longer contain
All checks were successful
CI / Classify the change (pull_request) Successful in 8s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 13s
CI / Server smoke test (pull_request) Successful in 9s
CI / Docker build (pull_request) Successful in 24s
CI / Test (Node 20) (pull_request) Successful in 54s
CI / Test (Node 18) (pull_request) Successful in 1m4s
CI / Test (Node 22) (pull_request) Successful in 1m4s
CI / Arm auto-merge (pull_request) Successful in 5s
d76a878545
The drift table claimed the README says "53 media types across eight families
and 18 connector cages" (README.md:84) and "91 models / 17 vendors"
(README.md:80), with the engine at 65 media and 905 specs across 199 vendors.
Neither half is true now: the README prints 90 media types across ten families
and 28 cages, and 2,344 models across 258 vendors in 25 categories, and those
are the measured values (engine/media.js MEDIA + CAGES, devices/registry.js).
It also reported docs/CLI.md:50 as calling `ip address dhcp` "(reserved)" —
CLI.md documents it as a live DHCP client with the one-method rule, and
engine/cli.js _ifaceMode() displaces the static address and names it.

Rows rewritten to cite sections rather than line numbers where the text is
still accurate, the ARCHITECTURE capability quote corrected to the row that
exists (line 42, and dhcp-* is live, not inert), the ROADMAP row's exception
list corrected (DHCP is in the data path since #1051, the page says so in
§5.1), and the four departures recorded with the commands that re-measure them.
jaylouisw force-pushed docs/1117-0445 from d76a878545
All checks were successful
CI / Classify the change (pull_request) Successful in 8s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 13s
CI / Server smoke test (pull_request) Successful in 9s
CI / Docker build (pull_request) Successful in 24s
CI / Test (Node 20) (pull_request) Successful in 54s
CI / Test (Node 18) (pull_request) Successful in 1m4s
CI / Test (Node 22) (pull_request) Successful in 1m4s
CI / Arm auto-merge (pull_request) Successful in 5s
to 9d69826e88
All checks were successful
CI / Classify the change (pull_request) Successful in 9s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 7s
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 57s
CI / Test (Node 18) (pull_request) Successful in 1m4s
CI / Test (Node 22) (pull_request) Successful in 1m1s
CI / Arm auto-merge (pull_request) Successful in 18s
2026-11-17 04:52:38 +00:00
Compare
jaylouisw force-pushed docs/1117-0445 from 9d69826e88
All checks were successful
CI / Classify the change (pull_request) Successful in 9s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 7s
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 57s
CI / Test (Node 18) (pull_request) Successful in 1m4s
CI / Test (Node 22) (pull_request) Successful in 1m1s
CI / Arm auto-merge (pull_request) Successful in 18s
to 986cc7d195
All checks were successful
CI / Classify the change (pull_request) Successful in 7s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 5s
CI / Test (Node 18) (pull_request) Has been skipped
CI / Test (Node 20) (pull_request) Has been skipped
CI / Test (Node 22) (pull_request) Has been skipped
CI / Server smoke test (pull_request) Has been skipped
CI / Docker build (pull_request) Has been skipped
CI / Arm auto-merge (pull_request) Has been skipped
2026-11-17 04:55:56 +00:00
Compare
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!1792
No description provided.