Align both roadmaps with the roadmap grammar - #245
Open
leynos wants to merge 2 commits into
Open
Conversation
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
|
Note Reviews pausedIt 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 Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
Summary
WalkthroughReformat both Lille roadmap documents with numbered hierarchy, updated subsection syntax, and an inline health-type link. Extend ChangesDocumentation and spelling updates
Possibly related PRs
Suggested labels: Poem
🚥 Pre-merge checks | ✅ 20✅ Passed checks (20 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![codescene-access[bot]](https://avatars.githubusercontent.com/in/3755875?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
leynos
force-pushed
the
docs/roadmap-syntax
branch
from
July 8, 2026 11:04
26ef93d to
b87cd64
Compare
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
leynos
marked this pull request as ready for review
July 24, 2026 15:36
The roadmap grammar requires numbered phase and step headings of the form "## N. Title" and "### N.M. Title", forbids unnumbered headings after the first phase, and rejects reference-style links. In docs/lille-map-and-presentation-roadmap.md, rewrite the "## Phase N: Title" and "### Step N.M: Title" headings to the numbered forms, keeping every number and title unchanged. In docs/lille-physics-and-world-engine-roadmap.md: - Drop the stray section number from "## 1. Vision and Strategy" so the section reads as preamble instead of a phase; this also places the Bevy Upgrade Checklist in the preamble, where unnumbered sections are valid. - Rewrite the "## Phase N: Title" headings to "## N. Title". - Demote the unnumbered "### Tick timing" heading, which sits inside phase 3, to a bold paragraph in place. - Convert the "[canonical type definitions][health-type-defs]" reference-style link to an inline link and remove the link definition, because reference links are unsupported. No phases, steps, tasks, numbering, ordering, or checkbox states change. The mapsplice checker now parses both documents cleanly.
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates both Lille roadmap documents to conform to the mapsplice roadmap grammar by renumbering phase/step headings into strict numeric forms, adjusting a misparsed preamble heading, demoting an internal subheading to emphasized text, and inlining a reference-style link while preserving roadmap structure and tasks. Sequence diagram for mapsplice roadmap grammar validation after heading updatessequenceDiagram
actor Developer
participant mapsplice
participant roadmap_file as LilleRoadmapMarkdown
participant grammar_checker as RoadmapGrammarChecker
Developer->>mapsplice: mapsplice append docs/lille-physics-and-world-engine-roadmap.md dummy_phase
mapsplice->>roadmap_file: load_document
mapsplice->>grammar_checker: validate_headings
grammar_checker-->>mapsplice: headings_valid
mapsplice->>grammar_checker: validate_links
grammar_checker-->>mapsplice: links_valid
mapsplice-->>Developer: exit 0
Developer->>mapsplice: mapsplice append docs/lille-map-and-presentation-roadmap.md dummy_phase
mapsplice->>roadmap_file: load_document
mapsplice->>grammar_checker: validate_headings
grammar_checker-->>mapsplice: headings_valid
mapsplice-->>Developer: exit 0
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b87cd64107
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
lodyai
Bot
force-pushed
the
docs/roadmap-syntax
branch
from
July 24, 2026 15:48
b87cd64 to
bb5b9ea
Compare
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Record the Oxford spelling entries regenerated by the documentation gate so subsequent validation leaves the worktree clean.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Collaborator
|
@coderabbitai review |
Contributor
✅ Action performedReview finished.
|
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/lille-physics-and-world-engine-roadmap.md`:
- Line 3: Update the roadmap headings to sentence case:
docs/lille-physics-and-world-engine-roadmap.md lines 3, 42, 101, 153, and 303
should use “Vision and strategy,” “Foundational migration to DBSP,” “Achieving
physics parity,” “Expanding physics and agent dynamics,” and “Advanced features
and polish,” respectively.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 6b4f21b6-45b5-4ce6-9462-ddaf287eb012
📒 Files selected for processing (3)
docs/lille-map-and-presentation-roadmap.mddocs/lille-physics-and-world-engine-roadmap.mdtypos.toml
| # Lille Physics and World Engine Roadmap | ||
|
|
||
| ## 1. Vision and Strategy | ||
| ## Vision and Strategy |
Contributor
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use sentence case for the updated roadmap headings.
The changed headings remain in title case, contrary to the documentation style instruction.
docs/lille-physics-and-world-engine-roadmap.md#L3-L3: ChangeVision and StrategytoVision and strategy.docs/lille-physics-and-world-engine-roadmap.md#L42-L42: ChangeFoundational Migration to DBSPtoFoundational migration to DBSP.docs/lille-physics-and-world-engine-roadmap.md#L101-L101: ChangeAchieving Physics ParitytoAchieving physics parity.docs/lille-physics-and-world-engine-roadmap.md#L153-L153: ChangeExpanding Physics and Agent DynamicstoExpanding physics and agent dynamics.docs/lille-physics-and-world-engine-roadmap.md#L303-L303: ChangeAdvanced Features and PolishtoAdvanced features and polish.
Triage: [type:docstyle]
📍 Affects 1 file
docs/lille-physics-and-world-engine-roadmap.md#L3-L3(this comment)docs/lille-physics-and-world-engine-roadmap.md#L42-L42docs/lille-physics-and-world-engine-roadmap.md#L101-L101docs/lille-physics-and-world-engine-roadmap.md#L153-L153docs/lille-physics-and-world-engine-roadmap.md#L303-L303
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/lille-physics-and-world-engine-roadmap.md` at line 3, Update the roadmap
headings to sentence case: docs/lille-physics-and-world-engine-roadmap.md lines
3, 42, 101, 153, and 303 should use “Vision and strategy,” “Foundational
migration to DBSP,” “Achieving physics parity,” “Expanding physics and agent
dynamics,” and “Advanced features and polish,” respectively.
Source: Path instructions
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This branch aligns both namespaced roadmaps with the mapsplice roadmap
grammar, which requires numbered phase and step headings (
## N. Title,### N.M. Title), forbids unnumbered headings after the first phase,and rejects reference-style links. Headings written as
## Phase N: Titleand### Step N.M: Titleare rewritten to the numbered formswith every number and title kept intact. No phases, steps, tasks,
numbering, ordering, or checkbox states change, and the files are not
renamed.
Review walkthrough
Phase/Stepheadings become## N./### N.M.forms.## 1. Vision and Strategy(making it and the Bevy Upgrade Checklist preamble), demotes the unnumbered### Tick timingheading inside phase 3 to a bold paragraph, and inlines the[health-type-defs]reference-style link.Validation
mapsplice append docs/lille-map-and-presentation-roadmap.md <dummy-phase>: exit 0 (grammar-clean)mapsplice append docs/lille-physics-and-world-engine-roadmap.md <dummy-phase>: exit 0 (grammar-clean)bunx markdownlint-cli2on both files: 0 errorsNotes
## 1. Vision and Strategycarried a document-section number thatmade the checker parse it as phase 1, colliding with the real phase 1
(
Phase 1: Foundational Migration to DBSP). Removing that straynumber, rather than renumbering the four real phases, keeps every
existing phase number stable and turns the section into valid
preamble.
Vision section is unnumbered, it sits in the preamble, where the
grammar accepts unnumbered sections and checklists.
- [x] Task 1.1.1 — ...and the ordered**Key Tasks**groupings are accepted by the checker as they stand,so they are left untouched.
**Tick timing:**paragraph ends with a colon so thatmarkdownlint's MD036 (emphasis-as-heading) rule does not fire.
cross-reference into the physics roadmap is a commit-pinned permalink
with line numbers, which is unaffected.
Summary by Sourcery
Align the Lille map/presentation and physics/world-engine roadmap documents with the roadmap grammar by standardizing numbered phase/step headings, adjusting preamble structure, and replacing reference-style links with inline links while keeping all roadmap content and task structure intact.
Enhancements:
Documentation:
References