Skip to content

Align roadmap with the roadmap grammar#111

Open
leynos wants to merge 1 commit into
mainfrom
docs/roadmap-syntax
Open

Align roadmap with the roadmap grammar#111
leynos wants to merge 1 commit into
mainfrom
docs/roadmap-syntax

Conversation

@leynos

@leynos leynos commented Jul 1, 2026

Copy link
Copy Markdown
Owner

Summary

This branch aligns docs/roadmap.md with the mapsplice roadmap grammar. The checker previously failed with "dependency anchor 2.5.1 was not found": every task number lacked its trailing dot (1.1.1 Ratify rather than 1.1.1. Ratify), so no task registered as a dependency anchor and every numbered Requires reference dangled. Three further latent violations surfaced once that was fixed: external Podbot step numbers were parsed as local anchors, task 2.2.3 used footnote references (unsupported inline nodes), and step 4.4's task checklist merged with the preceding dependency-label bullet list, so the 4.4.x tasks never registered as anchors.

Review walkthrough

  • Start with docs/roadmap.md to see the four changes: trailing dots on all 80 task numbers; backticks around external Podbot step numbers (e.g. Podbot Step 4.6) so they leave the dependency-reference context; the three footnotes in task 2.2.3 converted to inline "See" sentences with the definitions removed; and a Tasks: paragraph inserted in step 4.4 to separate the shared dependency-label bullets from the task checklist.

Validation

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

Notes

  • The Podbot step references intentionally point at the Podbot development roadmap, so the numbers were backticked rather than renumbered; wording is otherwise unchanged. All Step N.N numbers were backticked uniformly (including ones that happened to resolve against local steps, such as Podbot Step 2.5) to avoid false local resolution.
  • The Tasks: paragraph in step 4.4 is the minimal structural separator: without it, CommonMark treats the label bullets and the checklist as one loose list. No items were reordered, renumbered, or reworded.
  • docs/roadmap-writing-guide.md is a guide rather than a roadmap and was left untouched.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Please try again later or upgrade to continue using Sourcery

@coderabbitai

coderabbitai Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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

Walkthrough

This PR reformats docs/roadmap.md for consistent Markdown checklist presentation: normalised punctuation after numbered items, reflowed bullet line wrapping, and a small "Tasks:" label addition. No headings, milestones, or dependency references change in meaning.

Changes

Roadmap formatting reflow

Layer / File(s) Summary
Phase 1 checklist reflow
docs/roadmap.md
Dependency-label bullets and task/handoff sections reformatted with consistent numbering punctuation and wrapped lines.
Phase 2-3 checklist reflow
docs/roadmap.md
Slash-command, tenant isolation, subphase 3.1, and tool-plane/governance checklists normalised.
Phase 4-5 checklist reflow
docs/roadmap.md
Section 4.1, HTTP API, real-time streaming, front-end, and reliability/security checklists reformatted.
Testing, performance, and conversations checklist reflow
docs/roadmap.md
Testing/quality-gates, deployment/resilience, performance/scalability, and conversations/SSE replay checklists reformatted.
Phase 8 checklist reflow
docs/roadmap.md
Fixture-backed projection, conversation surface, directives/suggestions, settings/identity, and closing references reformatted.

Possibly related PRs

  • leynos/ddlint#210: Both PRs reformat/restructure docs/roadmap.md checklist and numbering formatting.
  • leynos/corbusier#58: Both PRs modify docs/roadmap.md checklist numbering formatting.
  • leynos/gauss#103: Both PRs are purely Markdown reflow changes to checklist/list punctuation and wrapping.

Suggested labels: Roadmap

Poem

A rabbit hopped through roadmap lines,
Straightened dots and tidied signs.
No task was lost, no milestone bent,
Just neater bullets, well-content.
Thump thump — reflowed, and off it went! 🐇

🚥 Pre-merge checks | ✅ 19 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Testing (Compile-Time / Ui) ⚠️ Warning PR modifies docs/roadmap.md to align with mapsplice grammar, but includes no snapshot or compile-time tests to validate the grammar-compliance changes. Add a snapshot test that verifies docs/roadmap.md parses cleanly under the mapsplice grammar, encoding the dependency-anchor resolution and task-reference validation as meaningful semantic assertions.
✅ Passed checks (19 passed)
Check name Status Explanation
Title check ✅ Passed The title matches the PR’s main change by describing the roadmap grammar alignment work.
Description check ✅ Passed The description directly explains the roadmap syntax fixes and matches the files changed.
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 Treat this as PASS: the PR only reformats docs/roadmap.md; no runtime behaviour or test files changed, so no new test coverage is required.
User-Facing Documentation ✅ Passed Only docs/roadmap.md changed; no user-facing functionality or behaviour changed, so the users-guide requirement is not triggered.
Developer Documentation ✅ Passed PASS: The PR only normalises roadmap Markdown; no APIs, architecture, or build requirements changed, and the related roadmap items already have COMPLETE execplans.
Module-Level Documentation ✅ Passed Only docs/roadmap.md changed; no module files were touched, so the module-docstring requirement is not applicable here.
Testing (Unit And Behavioural) ✅ Passed PASS: only docs/roadmap.md changed; no functional code or public entities were touched, so unit/behavioural tests were not applicable.
Testing (Property / Proof) ✅ Passed PR modifies only docs/roadmap.md (Markdown documentation formatting). No code, properties, invariants, lemmas, or proofs introduced; check not applicable.
Unit Architecture ✅ Passed Only docs/roadmap.md changed; no code paths, dependencies, or tests were touched, so unit-architecture boundaries are unaffected.
Domain Architecture ✅ Passed Only docs/roadmap.md changed; the edits are Markdown formatting and checklist structure, not domain logic or boundary leakage.
Observability ✅ Passed PASS: HEAD only changes docs/roadmap.md, so no operational behaviour, logging, metrics, tracing, or alerts were introduced.
Security And Privacy ✅ Passed Pass: the PR only reformats roadmap Markdown and backticks external step references; it adds no secrets, auth changes, or sensitive-data exposure.
Performance And Resource Use ✅ Passed Accept it: only docs/roadmap.md changed, and the diff is Markdown reformatting plus wording, with no executable paths or resource-sensitive logic.
Concurrency And State ✅ Passed PASS: The PR only edits docs/roadmap.md formatting; it introduces no code, shared state, async work, locks, tasks, or ordering-sensitive behaviour.
Architectural Complexity And Maintainability ✅ Passed Only docs/roadmap.md changed; no code, dependencies, or new abstractions were introduced.
Rust Compiler Lint Integrity ✅ Passed No Rust files changed; only docs/roadmap.md was edited, so the lint/clone rules are not implicated.
✨ 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.

codescene-access[bot]

This comment was marked as outdated.

@leynos
leynos force-pushed the docs/roadmap-syntax branch from 3dde9bd to 0ed9e7e Compare July 2, 2026 22:00
codescene-access[bot]

This comment was marked as outdated.

@leynos
leynos force-pushed the docs/roadmap-syntax branch from 0ed9e7e to 4627ef2 Compare July 2, 2026 22:13
codescene-access[bot]

This comment was marked as outdated.

@leynos
leynos force-pushed the docs/roadmap-syntax branch from 4627ef2 to a4b1849 Compare July 3, 2026 07:06
codescene-access[bot]

This comment was marked as outdated.

Fix syntax-shape violations in docs/roadmap.md so it parses under the
mapsplice roadmap grammar:

- Add the trailing dot to all 80 task numbers (e.g. "1.1.1 Ratify" to
  "1.1.1. Ratify") so tasks register as dependency anchors and the
  intra-document "Requires" references resolve.
- Wrap external Podbot step numbers in backticks (e.g. Podbot Step
  `4.6`) so they leave the dependency-reference context; they point at
  the Podbot roadmap, not this document.
- Convert the three footnote references in task 2.2.3 to inline "See"
  sentences and remove the footnote definitions; footnotes are
  unsupported inline nodes under the grammar.
- Insert a "Tasks:" paragraph in step 4.4 between the shared dependency
  label bullets and the task checklist so the two lists no longer merge
  into a single Markdown list, which prevented the 4.4.x tasks from
  registering as anchors.

No items were reordered, renumbered, or reworded beyond the above.
@pandalump
pandalump force-pushed the docs/roadmap-syntax branch from a4b1849 to d926593 Compare July 3, 2026 08:27
@pandalump
pandalump marked this pull request as ready for review July 3, 2026 08:27
@coderabbitai coderabbitai Bot added the Roadmap label Jul 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant