plan: the roadmap is an invitation to build what is already built #1731

Merged
jaylouisw merged 1 commit from plan/1116-2110 into main 2026-11-16 21:15:49 +00:00
Owner

Plan only, no code. Adds docs/plans/roadmap-rebase.md.

docs/ROADMAP.md is the page README.md:204 and docs/CLI.md:1765 both send readers to, and it has been edited twice in its life. Measured on e4d0cde2:

  • :8-12, :14 - DHCP, DNS, VLANs/802.1Q, STP, OSPF and ACLs are all unchecked, and all six ship: engine/dhcp.js (843 lines, "in the data path since #1051" at docs/SIMULATION.md:277), engine/dns.js (631), engine/vlan.js (619), engine/stp.js (324), engine/ospf.js (732), engine/acl.js (483), each with a suite.
  • :12 - OSPF/RIP is one row and cannot be flipped either way: OSPF is real, RIP has no file and no reference in engine/.
  • :31 - file-backed persistence is called absent; server/index.js:147 writes every board through temp-file-and-rename and loadSavedTopologies() reloads it at boot.
  • :39 - CI is called absent; there are five workflows.
  • :43-45 - "the test suite is node test/engine.test.js" names one of 290 suites; npm test is scripts/run-tests.js.
  • Six shipped subsystems have no row at all: VRRP, BGP, IPv6/SLAAC, LAG, LLDP, SCION.

Rows that are correct stay correct: wireless association (engine/device.js:115 says the token is unread), vendor translators, auth, pcap, and most of the UI list.

docs/SIMULATION.md:634 already carries an apology for this; the plan's step 5 retires it in the same PR as the footer rewrite so the two cannot disagree.

Steps are three docs-only section PRs (S each), a footer-and-policy PR (S) and an optional checker (M) that needs Jay's decision. Risks: counts rot (cite files and anchors, never totals), overclaiming wireless, and turning ROADMAP into a second SIMULATION.md.

Closes no open issue - 18 of the 19 are device-request and #1507 is the 46 GB firmware history, which needs the host.

Gates: node scripts/check-control-bytes.js clean; node scripts/check-doc-citations.js adds no suspect.

Plan only, no code. Adds `docs/plans/roadmap-rebase.md`. `docs/ROADMAP.md` is the page `README.md:204` and `docs/CLI.md:1765` both send readers to, and it has been edited twice in its life. Measured on `e4d0cde2`: - **`:8-12`, `:14`** - DHCP, DNS, VLANs/802.1Q, STP, OSPF and ACLs are all unchecked, and all six ship: `engine/dhcp.js` (843 lines, "in the data path since #1051" at `docs/SIMULATION.md:277`), `engine/dns.js` (631), `engine/vlan.js` (619), `engine/stp.js` (324), `engine/ospf.js` (732), `engine/acl.js` (483), each with a suite. - **`:12`** - OSPF/RIP is one row and cannot be flipped either way: OSPF is real, RIP has no file and no reference in `engine/`. - **`:31`** - file-backed persistence is called absent; `server/index.js:147` writes every board through temp-file-and-rename and `loadSavedTopologies()` reloads it at boot. - **`:39`** - CI is called absent; there are five workflows. - **`:43-45`** - "the test suite is `node test/engine.test.js`" names one of 290 suites; `npm test` is `scripts/run-tests.js`. - Six shipped subsystems have no row at all: VRRP, BGP, IPv6/SLAAC, LAG, LLDP, SCION. Rows that are correct stay correct: wireless association (`engine/device.js:115` says the token is unread), vendor translators, auth, pcap, and most of the UI list. `docs/SIMULATION.md:634` already carries an apology for this; the plan's step 5 retires it in the same PR as the footer rewrite so the two cannot disagree. Steps are three docs-only section PRs (S each), a footer-and-policy PR (S) and an optional checker (M) that needs Jay's decision. Risks: counts rot (cite files and anchors, never totals), overclaiming wireless, and turning ROADMAP into a second SIMULATION.md. Closes no open issue - 18 of the 19 are `device-request` and #1507 is the 46 GB firmware history, which needs the host. Gates: `node scripts/check-control-bytes.js` clean; `node scripts/check-doc-citations.js` adds no suspect.
plan: the roadmap is an invitation to build what is already built
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 17s
CI / Server smoke test (pull_request) Successful in 22s
CI / Test (Node 20) (pull_request) Successful in 56s
CI / Docker build (pull_request) Successful in 31s
CI / Test (Node 18) (pull_request) Successful in 59s
CI / Test (Node 22) (pull_request) Successful in 1m3s
CI / Arm auto-merge (pull_request) Successful in 13s
4eafed1c74
docs/ROADMAP.md has been touched twice in its life and its engine section
lists seven shipped subsystems as unchecked TODOs (DHCP, DNS, VLANs, STP,
OSPF, ACLs) while the platform section calls file-backed storage absent
(server/index.js:147). It also omits VRRP, BGP, IPv6/SLAAC, LAG, LLDP and
SCION, and its footer names node test/engine.test.js as "the test suite"
where package.json runs scripts/run-tests.js over 290 suites.

Plan only: three section PRs, a footer-and-policy PR that also retires the
apology at docs/SIMULATION.md:634, and an optional checker left for Jay.
No engine, test or workflow change.
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!1731
No description provided.