docs(ARCHITECTURE): four stale neighbour-suite counts, re-measured #1896

Merged
jaylouisw merged 1 commit from docs/1117-2046 into main 2026-11-17 20:57:02 +00:00
Owner

What was untrue

docs/ARCHITECTURE.md states live suite counts in the present tense ("Neighbours green: ipv6 235, ..."). Four of those numbers no longer match what the suites print, because the suites grew after the sentences were written and nothing re-derives the page.

line suite doc said prints today grew in
862 ping-ipv6 43 44 #1712 (a bare ping <address> sends five echoes)
862 config-completeness 56 59 #1869 (ip routing / no ip routing)
863 show-interfaces-port 38 40 #1568 (no vlan 22 leaves its access ports inactive)
952 show-arp 28 31 #1625 (show arp prints the vendor Type column)

Evidence

Measured, twice, on this tree � the counts are stable and are what each suite prints as N passed, 0 failed:

ping-ipv6 44 | config-completeness 59 | show-interfaces-port 40 | show-arp 31

Every other suite named in both "Neighbours green" lists � and in the two earlier lists at lines 778 and 819 � was measured too and agrees: ipv6 235, ipv6-slaac 165, ipv6-wire 33, config-roundtrip 46, state-payload-complete 16, examples-generated 21, flows-survive-save-load 16, show-interfaces-view-keywords 97, spec-survives-load 32, arp-ageing 31, runtime-agreement 10, show-argument-refusal 77, show-ip-spellings 70, dhcp-bindings 67, lldp 27, vrrp 94, dhcp 134, dhcp-pool-undo 51, show-lldp 23, lldp-across-trunk 32, dhcp-leases-survive-save 32, counters-agreement 32, link-state 69, stp-port-state 31, poe 18, pon-splitter 33. So only these four moved.

Not in this PR

docs/plans/doc-counts.md (step 2) is the eventual fix: a guard that measures each named suite and fails on the drift, with step 5 deferring these short-name lists. That guard does not exist yet, so this is the hand pass it would replace. No code changed.

Guards

node scripts/syntax-check.js � 393 files, all OK. docs-cli-transcript 4/0, docs-show-commands 7/0, help-completeness 8/0, no-form-help-key 81/0, help-key-is-not-a-value 40/0, help-key-works-in-every-prompt 10 pass, doc-citations 11/0, canonical-urls 52/0. No transcript or command form touched.

## What was untrue `docs/ARCHITECTURE.md` states live suite counts in the present tense ("Neighbours green: `ipv6` 235, ..."). Four of those numbers no longer match what the suites print, because the suites grew after the sentences were written and nothing re-derives the page. | line | suite | doc said | prints today | grew in | |---|---|---|---|---| | 862 | `ping-ipv6` | 43 | **44** | #1712 (a bare `ping <address>` sends five echoes) | | 862 | `config-completeness` | 56 | **59** | #1869 (`ip routing` / `no ip routing`) | | 863 | `show-interfaces-port` | 38 | **40** | #1568 (`no vlan 22` leaves its access ports inactive) | | 952 | `show-arp` | 28 | **31** | #1625 (`show arp` prints the vendor Type column) | ## Evidence Measured, twice, on this tree � the counts are stable and are what each suite prints as `N passed, 0 failed`: ``` ping-ipv6 44 | config-completeness 59 | show-interfaces-port 40 | show-arp 31 ``` Every other suite named in both "Neighbours green" lists � and in the two earlier lists at lines 778 and 819 � was measured too and agrees: `ipv6` 235, `ipv6-slaac` 165, `ipv6-wire` 33, `config-roundtrip` 46, `state-payload-complete` 16, `examples-generated` 21, `flows-survive-save-load` 16, `show-interfaces-view-keywords` 97, `spec-survives-load` 32, `arp-ageing` 31, `runtime-agreement` 10, `show-argument-refusal` 77, `show-ip-spellings` 70, `dhcp-bindings` 67, `lldp` 27, `vrrp` 94, `dhcp` 134, `dhcp-pool-undo` 51, `show-lldp` 23, `lldp-across-trunk` 32, `dhcp-leases-survive-save` 32, `counters-agreement` 32, `link-state` 69, `stp-port-state` 31, `poe` 18, `pon-splitter` 33. So only these four moved. ## Not in this PR `docs/plans/doc-counts.md` (step 2) is the eventual fix: a guard that measures each named suite and fails on the drift, with step 5 deferring these short-name lists. That guard does not exist yet, so this is the hand pass it would replace. No code changed. ## Guards `node scripts/syntax-check.js` � 393 files, all OK. `docs-cli-transcript` 4/0, `docs-show-commands` 7/0, `help-completeness` 8/0, `no-form-help-key` 81/0, `help-key-is-not-a-value` 40/0, `help-key-works-in-every-prompt` 10 pass, `doc-citations` 11/0, `canonical-urls` 52/0. No transcript or command form touched.
docs(ARCHITECTURE): the neighbour-suite counts are readings, and four had drifted
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 16s
CI / Server smoke test (pull_request) Successful in 7s
CI / Docker build (pull_request) Successful in 25s
CI / Test (Node 20) (pull_request) Successful in 49s
CI / Test (Node 22) (pull_request) Successful in 52s
CI / Test (Node 18) (pull_request) Successful in 59s
CI / Arm auto-merge (pull_request) Successful in 12s
2de363b027
Re-measured every suite named in the two "Neighbours green" lists this page
carries, against this tree:

  ping-ipv6             43 -> 44   (#1712 gave a bare ping its five echoes)
  config-completeness   56 -> 59   (#1869 added ip routing / no ip routing)
  show-interfaces-port  38 -> 40   (#1568 deletes the VLAN, not its access ports)
  show-arp              28 -> 31   (#1625 prints the vendor Type column)

Each is a live count the sentence states in the present tense; the suites grew
after the sentences were written and nothing re-derived them. The other suite
counts in both lists (and in the two lists above them) were measured too and are
correct, so only these four moved.

Verified: node scripts/syntax-check.js (393 files, all OK); docs-cli-transcript
4/0, docs-show-commands 7/0, help-completeness 8/0, no-form-help-key 81/0,
help-key-is-not-a-value 40/0, help-key-works-in-every-prompt 10 pass,
doc-citations 11/0, canonical-urls 52/0.
jaylouisw force-pushed docs/1117-2046 from 2de363b027
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 16s
CI / Server smoke test (pull_request) Successful in 7s
CI / Docker build (pull_request) Successful in 25s
CI / Test (Node 20) (pull_request) Successful in 49s
CI / Test (Node 22) (pull_request) Successful in 52s
CI / Test (Node 18) (pull_request) Successful in 59s
CI / Arm auto-merge (pull_request) Successful in 12s
to bef1f92e2f
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 8s
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 46s
CI / Test (Node 18) (pull_request) Successful in 53s
CI / Test (Node 22) (pull_request) Successful in 51s
CI / Arm auto-merge (pull_request) Successful in 17s
2026-11-17 20:55:03 +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!1896
No description provided.