Skip to content

docs: post-roadmap truth pass — coverage matrices, user guide, README, golden statuses, ADR banners (release-gate item 4) #126

Description

@JArmandoAnaya

What

Post-roadmap docs truth pass — the merged P3/P4/P5/P8 work was never written back into the documents that describe it. This is release-gate item 4 (docs synchronized with shipped behavior). Full evidence in the 2026-08-02 audit; headline items:

docs/roadmap/coverage/osc-xml-coverage.md

  • ~21 rows still carry "planned/deferred (p3-s4 | p4-s4 | p5-s4 | p2-s1)" markers for work that landed (position rows :180-182 literally say "reported unsupported; resolution planned (p3-s4)" while position_resolver.cpp resolves them; rows :40, :41, :43, :44, :51, :53, :108-119, :149, :158, :165, :170, :190; by-entity preamble :88-101 contradicts :168 on EntitySelection)
  • Summary counts wrong: conditions are 22-In/2-Post of 24 (not "21 of 24 … 3 Post"); the actions total doesn't reconcile (:218)
  • No road/OpenDRIVE section and no road suite named anywhere — P3's delivery is invisible; add a Road network table (RoadNetwork/LogicFile/SceneGraphFile/UsedArea, supported OpenDRIVE subset) citing road_integration_test.cpp, route_test.cpp, road_query_contract_test.cpp
  • Missing rows: FileHeader License (1.1) / Properties (1.2) (warned at loader.cpp:235-250), Properties/File, Properties/CustomContent, EnvironmentAction DomeImage

docs/roadmap/coverage/osc-dsl-coverage.md

  • §7.6 table (lines 132-136) says until/wait@event/emit/on/call are Exec In — contradicting its own lowering table (line 62: Post) and the code; fix to match reality
  • False Exec-In rows for the un-lowered §8.8 actions and the method-backed rows (§112/178/179/184 — no method call ever folds); phantom rows vehicle_group (:166, :182 — explicitly not in the library, stdlib.cpp:255) and override() (:85 — declared nowhere)
  • Summary percentages wrong (lines 249-255; e.g. §8.9 is 9 of 17, not "13 of 18")
  • Add a Tests column so the CI checker's rule 3 applies to this matrix at all

User guide self-contradictions (each file says "pending" early and "live" later): positions.md:15-27 vs :108; conditions.md:388-395 vs :429, plus :74, :214, :421-426; entities.md:145-149; loading-scenarios.md:69; global-actions.md:85,389-399; motion.md:364,372.

README.md — roadmap table still marks F0 "current" and F1-F3 "planned"; frontends/dsl labelled "planned" in the architecture diagram; no mention of scena-run/scena-check or the user guide. Single most visible stale artifact at tag time.

golden-scenarios.md — GS-4/GS-7 still say the XML form "awaits P4"; GS-5/6/9/10/11 have no Status line; GS-2's lane-id note cites closed #23.

ADR supersession banners (repo convention per ADR-0002): ADR-0013 → superseded-in-part by ADR-0024/0025; ADR-0024:145 "Still deferred to #51" (delivered by ADR-0025); ADR-0021/ADR-0026 cite #52/#62 as live.

roadmap.md / issue seeds name dsl_composition_test.cpp, dsl_modifier_test.cpp, dsl_parity_test.cpp — never created; the work shipped in dsl_lowering_test.cpp + goldens. Add delivery notes rather than rewriting history.

Done when

  • Both matrices state only what is true, with delivered rows citing real suites and every remaining deferral owned by an open issue
  • User guide contradictions resolved (single status per feature per page)
  • README release pass done; golden-scenarios.md statuses complete
  • ADR banners added; roadmap delivery notes added

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions