docs(simulation): §5.5 called #42/#43/#44 known defects, and both links named headings that no longer exist #1977

Merged
jaylouisw merged 1 commit from docs/1118-1116 into main 2026-11-18 11:21:32 +00:00
Owner

Docs-only.

docs/SIMULATION.md §5.5 closed with:

Known defects that change what a lab will show: #42, #43, #44.

Two things were untrue:

  1. The status. §10 of the same page is titled Fixed defects, kept visible and lists #42/#43/#44 as fixed (the five were fixed in 7c694c48). The code agrees: connected networks are excluded from OSPF installation (engine/simulator.js:1561, #42) and a passive interface forms no adjacency (engine/simulator.js:1434, #43).
  2. The anchor. #10-known-open-defects stopped existing when §10 was renamed; the link went nowhere.

The same page's [§5.1] link also still read #51-dhcp--absent-from-the-data-path while §5.1 is titled in the data path (since #1051) — and Simulator.computeDhcp() runs before the first packet (engine/simulator.js:618), so "absent" was the stale half.

Both links now name the headings that exist, and §5.5 says the three are fixed rather than known.

Guards: syntax-check 413 files OK; docs-show-commands 7/7; help-completeness 8/8; no-form-help-key 81/81; check-control-bytes clean; doc-citations 353 citations, 3 suspects (pre-existing, within the 40-line allowance).

Docs-only. `docs/SIMULATION.md` §5.5 closed with: > Known defects that change what a lab will show: [#42, #43, #44](#10-known-open-defects). Two things were untrue: 1. **The status.** §10 of the same page is titled *Fixed defects, kept visible* and lists #42/#43/#44 as fixed (the five were fixed in 7c694c48). The code agrees: connected networks are excluded from OSPF installation (`engine/simulator.js:1561`, #42) and a passive interface forms no adjacency (`engine/simulator.js:1434`, #43). 2. **The anchor.** `#10-known-open-defects` stopped existing when §10 was renamed; the link went nowhere. The same page's `[§5.1]` link also still read `#51-dhcp--absent-from-the-data-path` while §5.1 is titled *in the data path (since #1051)* — and `Simulator.computeDhcp()` runs before the first packet (`engine/simulator.js:618`), so "absent" was the stale half. Both links now name the headings that exist, and §5.5 says the three are fixed rather than known. Guards: syntax-check 413 files OK; docs-show-commands 7/7; help-completeness 8/8; no-form-help-key 81/81; check-control-bytes clean; doc-citations 353 citations, 3 suspects (pre-existing, within the 40-line allowance).
docs(simulation): the OSPF defects §5.5 named are fixed, and both links into §10 and §5.1 still named old headings
All checks were successful
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 4s
CI / Classify the change (pull_request) Successful in 6s
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 51s
CI / Test (Node 18) (pull_request) Successful in 58s
CI / Test (Node 22) (pull_request) Successful in 54s
CI / Arm auto-merge (pull_request) Successful in 10s
726006aef8
§5.5 closed with "Known defects that change what a lab will show: [#42, #43, #44]",
linking to an anchor (`#10-known-open-defects`) that stopped existing when §10 became
"Fixed defects, kept visible" - and §10 of the same page lists #42/#43/#44 as fixed.

The code agrees with §10: connected networks are excluded from OSPF installation
(`engine/simulator.js:1561`, #42) and a passive interface forms no adjacency
(`engine/simulator.js:1434`, #43); the five were fixed in 7c694c48.

The same page's §5.1 link still read "absent from the data path" while §5.1 is titled
"in the data path (since #1051)", and `Simulator.computeDhcp()` runs before the first
packet (`engine/simulator.js:618`). Both links now name the headings that exist.
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!1977
No description provided.