Align roadmap with the roadmap grammar

[leynos]

Summary

This branch aligns the roadmap with the mapsplice roadmap grammar. The
trailing ## Benchmark dataset suite section (dataset table, provenance
notes, and two unnumbered level-3 subsections) sat after the numbered phases,
which the grammar rejects ("unsupported non-roadmap heading inside the roadmap
body"). It also used footnote references ([^1]–[^10]), which the grammar
rejects anywhere in the document. The section moves, headings and wording
intact, into the preamble before the first phase; the footnotes become inline
links on the dataset names in the table; the redundant footnote markers in the
provenance notes are dropped and the footnote definition block removed. No
phases, steps, or tasks are reordered, renumbered, or reworded, and no
checkbox states change.

Review walkthrough

• Start with docs/roadmap.md to see the benchmark dataset suite now in the preamble, with each dataset name in the table carrying the inline link that its footnote previously supplied; the phase body from ## 0. onwards is otherwise untouched.

Validation

• mapsplice append docs/roadmap.md <dummy-phase>: exit 0 (grammar-clean)
• bunx markdownlint-cli2 docs/roadmap.md: 0 errors

Notes

• Demoting the three headings to bold paragraphs in place was rejected
  because it trips markdownlint MD036 (emphasis used instead of a heading);
  the section is reference material rather than task-like content, so
  converting it to a numbered phase was also inappropriate.
• The provenance-note footnote markers duplicated the table's sources, so
  they were removed rather than duplicated as a second set of inline links;
  every footnote URL survives exactly once, on the dataset name in the table.
• Table columns were realigned (whitespace only) after the link substitution.
• Anomaly, deliberately not fixed: the roadmap numbers its first phase
  ## 0., which the grammar's phase rule disallows (phases must be positive
  integers), yet the mechanical checker accepts the document by treating the
  zero-numbered phase as preamble. Shifting to 1-based numbering would
  renumber every phase, step, task, and cross-reference in the document —
  exactly the renumbering churn this exercise forbids — so it is flagged
  here for a human decision instead.

[sourcery-ai]

Sorry @leynos, you have reached your weekly rate limit of 500000 diff characters.

Please try again later or upgrade to continue using Sourcery

[coderabbitai]

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

• @coderabbitai resume to resume automatic reviews.
• @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

• ▶️ Resume reviews
• 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: ce920420-aa9b-4a60-bca8-ab7f462dca08

📥 Commits

Reviewing files that changed from the base of the PR and between 84835fa and e38c1be.

📒 Files selected for processing (1)

• docs/roadmap.md

---

Aligned docs/roadmap.md with the mapsplice roadmap grammar by moving the trailing “Benchmark dataset suite” content into the preamble before the first phase, so the roadmap body contains only allowed roadmap headings and entries.

Also cleaned up the dataset section by:

• converting footnote-based dataset references to inline links
• removing redundant footnote markers from the provenance notes
• deleting the footnote definition block

No roadmap phases, steps, task states, or wording were reordered or changed.

Walkthrough

Documentation-only update to docs/roadmap.md: converts the benchmark dataset table from footnote-based citations to inline links, removes the footnote definitions block, adjusts related guidance prose, and fixes minor line-wrapping formatting in the exit-criteria section.

Changes

Roadmap Documentation Update

Layer / File(s)	Summary
Dataset table and guidance text docs/roadmap.md	Dataset entries switch from [^n] footnotes to inline linked names/URLs, the footnote definitions block is removed, and the "How to use them" and "Practical picks" prose is updated to match the new inline-link style.
Exit-criteria formatting fix docs/roadmap.md	Minor line-wrapping cleanup in the Streaming text validation exit-criteria paragraph.

Possibly related PRs

• leynos/ddlint#210: Also reformats docs/roadmap.md, restructuring dataset and phase presentation.

Suggested labels: Roadmap

Poem

A rabbit hopped through footnotes small,
And linked each dataset, one and all. 🐇
No more digits, [^n] set free,
Just tidy links for all to see.
Roadmap tidied, clean and bright!

🚥 Pre-merge checks | ✅ 20

✅ Passed checks (20 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly reflects the roadmap-grammar alignment changes in docs/roadmap.md.
Description check	✅ Passed	The description matches the PR and explains the roadmap-grammar cleanup in detail.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Testing (Overall)	✅ Passed	PASS: The PR only edits docs/roadmap.md; no code, behaviour, or test files changed, so the testing requirement is not applicable.
User-Facing Documentation	✅ Passed	PASS: only docs/roadmap.md changed; no code or user-facing behaviour changed, so docs/users-guide.md did not need an update.
Developer Documentation	✅ Passed	Only docs/roadmap.md changed; no APIs, architecture, ADRs, or guide updates were touched, and no checklist or execplan states changed.
Module-Level Documentation	✅ Passed	PASS: The PR only edits docs/roadmap.md; it adds no modules or module-level docs, so the module-docstring rule is not applicable.
Testing (Unit And Behavioural)	✅ Passed	Only docs/roadmap.md changed; no runtime or externally observable behaviour changed, so unit/behavioural tests were not applicable.
Testing (Property / Proof)	✅ Passed	Do not recommend property/proof testing: this documentation-only roadmap edit introduces no new invariant or proof obligation.
Testing (Compile-Time / Ui)	✅ Passed	PASS: only docs/roadmap.md changed, so there is no compile-time or UI surface to cover with trybuild or snapshot tests.
Unit Architecture	✅ Passed	Only docs/roadmap.md is affected, and it is prose-only; no query/command code, dependencies, or side-effects are introduced.
Domain Architecture	✅ Passed	Only docs/roadmap.md changed; no domain, adapter, transport, persistence, or infrastructure code was touched.
Observability	✅ Passed	Only docs/roadmap.md changed; no runtime behaviour, logging, metrics, tracing, or alerts were introduced or altered.
Security And Privacy	✅ Passed	Approve the change: it only edits public documentation and adds/removes public dataset links; no secrets, auth, permissions, or sensitive data appear.
Performance And Resource Use	✅ Passed	Only docs/roadmap.md changed; no executable logic, loops, I/O, allocation, or hot-path code was touched.
Concurrency And State	✅ Passed	Docs-only roadmap reflow: no code, shared state, async work, or concurrency primitives changed.
Architectural Complexity And Maintainability	✅ Passed	Only docs/roadmap.md changed; it reflows markdown and links, with no new abstractions, layers, or dependencies introduced.
Rust Compiler Lint Integrity	✅ Passed	No Rust files changed; keep the lint/clone rules unchanged because this patch only edits docs/roadmap.md.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/roadmap-syntax

---

_{Comment @coderabbitai help to get the list of available commands.}

[sourcery-ai]

Sorry @leynos, you have reached your weekly rate limit of 500000 diff characters.

Please try again later or upgrade to continue using Sourcery