Open
Conversation
Contributor
📝 WalkthroughWalkthroughConsolidates roadmap content into a single Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![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: f2541c9c26
ℹ️ 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}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/architecture-outline.md`:
- Around line 24-27: Update the wording in the architecture outline replacing
the overclaim "bit-exact scene port" with language that matches the implemented
guarantees: change the phrase to "deterministic scene port and canonical codec
boundary" (or similar), and reference the implementation-backed guarantees
(echo-wasm-abi/src/canonical.rs for the deterministic CBOR encoder/decoder,
echo-scene-port/src/canon.rs for float canonicalization, and the
echo-scene-codec/minicbor-based canonical codec boundary) so the doc aligns with
the actual deterministic/canonical behavior rather than claiming byte-for-byte
bit-exactness.
🪄 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: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 1c6d2d31-bda8-49a2-b125-f08fbbe60129
⛔ Files ignored due to path filters (130)
docs/archive/AGENTS.mdis excluded by!docs/archive/**docs/archive/ISSUES_MATRIX.mdis excluded by!docs/archive/**docs/archive/README.mdis excluded by!docs/archive/**docs/archive/ROADMAP/ECHO_ROADMAP.mdis excluded by!docs/archive/**docs/archive/ROLLBACK_TTD.mdis excluded by!docs/archive/**docs/archive/aion-papers-bridge.mdis excluded by!docs/archive/**docs/archive/branch-merge-playbook.mdis excluded by!docs/archive/**docs/archive/capability-ownership-matrix.mdis excluded by!docs/archive/**docs/archive/code-map.mdis excluded by!docs/archive/**docs/archive/determinism-invariants.mdis excluded by!docs/archive/**docs/archive/determinism/DETERMINISM-AUDIT.mdis excluded by!docs/archive/**docs/archive/determinism/DIND-MISSION-PHASE3.mdis excluded by!docs/archive/**docs/archive/determinism/DIND-MISSION-PHASE5.mdis excluded by!docs/archive/**docs/archive/determinism/DIND-MISSION.mdis excluded by!docs/archive/**docs/archive/diagrams.mdis excluded by!docs/archive/**docs/archive/guide/collision-tour.mdis excluded by!docs/archive/**docs/archive/hash-graph.mdis excluded by!docs/archive/**docs/archive/jitos/spec-0000.mdis excluded by!docs/archive/**docs/archive/math-validation-plan.mdis excluded by!docs/archive/**docs/archive/memorials/2026-01-18-phase4-rubicon.mdis excluded by!docs/archive/**docs/archive/notes/AFTER.webpis excluded by!docs/archive/**docs/archive/notes/BEFORE.webpis excluded by!docs/archive/**docs/archive/notes/Final.webpis excluded by!docs/archive/**docs/archive/notes/boaw-perf-baseline.mdis excluded by!docs/archive/**docs/archive/notes/claude-musings-on-determinism.mdis excluded by!docs/archive/**docs/archive/notes/f32scalar-deterministic-trig-implementation-guide.mdis excluded by!docs/archive/**docs/archive/notes/project-tour-2025-12-28.mdis excluded by!docs/archive/**docs/archive/notes/scheduler-optimization-followups.mdis excluded by!docs/archive/**docs/archive/notes/scheduler-radix-optimization-2.mdis excluded by!docs/archive/**docs/archive/notes/scheduler-radix-optimization.mdis excluded by!docs/archive/**docs/archive/notes/xtask-wizard.mdis excluded by!docs/archive/**docs/archive/phase1-plan.mdis excluded by!docs/archive/**docs/archive/plans/BOAW-tech-debt.mdis excluded by!docs/archive/**docs/archive/plans/COMING_SOON.mdis excluded by!docs/archive/**docs/archive/plans/SPEC-0004-final-plan.mdis excluded by!docs/archive/**docs/archive/plans/SPEC-0004-review-hitlist.mdis excluded by!docs/archive/**docs/archive/plans/cross-warp-parallelism.mdis excluded by!docs/archive/**docs/archive/plans/per-warp-time-sovereignty.mdis excluded by!docs/archive/**docs/archive/release-criteria.mdis excluded by!docs/archive/**docs/archive/rfc/mat-bus-finish.mdis excluded by!docs/archive/**docs/archive/roadmap-mwmr-mini-epic.mdis excluded by!docs/archive/**docs/archive/runtime-diagnostics-plan.mdis excluded by!docs/archive/**docs/archive/rust-rhai-ts-division.mdis excluded by!docs/archive/**docs/archive/scheduler-benchmarks.mdis excluded by!docs/archive/**docs/archive/scheduler-reserve-complexity.mdis excluded by!docs/archive/**docs/archive/scheduler-reserve-validation.mdis excluded by!docs/archive/**docs/archive/spec-deterministic-math.mdis excluded by!docs/archive/**docs/archive/spec-geom-collision.mdis excluded by!docs/archive/**docs/archive/study/aion.clsis excluded by!docs/archive/**docs/archive/study/build-tour.pyis excluded by!docs/archive/**docs/archive/study/diagrams/tour-01.mmdis excluded by!docs/archive/**docs/archive/study/diagrams/tour-01.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/diagrams/tour-01.svgis excluded by!**/*.svg,!docs/archive/**docs/archive/study/diagrams/tour-02.mmdis excluded by!docs/archive/**docs/archive/study/diagrams/tour-02.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/diagrams/tour-02.svgis excluded by!**/*.svg,!docs/archive/**docs/archive/study/diagrams/tour-03.mmdis excluded by!docs/archive/**docs/archive/study/diagrams/tour-03.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/diagrams/tour-03.svgis excluded by!**/*.svg,!docs/archive/**docs/archive/study/diagrams/tour-04.mmdis excluded by!docs/archive/**docs/archive/study/diagrams/tour-04.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/diagrams/tour-04.svgis excluded by!**/*.svg,!docs/archive/**docs/archive/study/diagrams/tour-05.mmdis excluded by!docs/archive/**docs/archive/study/diagrams/tour-05.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/diagrams/tour-05.svgis excluded by!**/*.svg,!docs/archive/**docs/archive/study/diagrams/tour-06.mmdis excluded by!docs/archive/**docs/archive/study/diagrams/tour-06.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/diagrams/tour-06.svgis excluded by!**/*.svg,!docs/archive/**docs/archive/study/diagrams/tour-07.mmdis excluded by!docs/archive/**docs/archive/study/diagrams/tour-07.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/diagrams/tour-07.svgis excluded by!**/*.svg,!docs/archive/**docs/archive/study/diagrams/tour-08.mmdis excluded by!docs/archive/**docs/archive/study/diagrams/tour-08.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/diagrams/tour-08.svgis excluded by!**/*.svg,!docs/archive/**docs/archive/study/diagrams/tour-09.mmdis excluded by!docs/archive/**docs/archive/study/diagrams/tour-09.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/diagrams/tour-09.svgis excluded by!**/*.svg,!docs/archive/**docs/archive/study/diagrams/tour-10.mmdis excluded by!docs/archive/**docs/archive/study/diagrams/tour-10.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/diagrams/tour-10.svgis excluded by!**/*.svg,!docs/archive/**docs/archive/study/diagrams/tour-11.mmdis excluded by!docs/archive/**docs/archive/study/diagrams/tour-11.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/diagrams/tour-11.svgis excluded by!**/*.svg,!docs/archive/**docs/archive/study/diagrams/tour-12.mmdis excluded by!docs/archive/**docs/archive/study/diagrams/tour-12.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/diagrams/tour-12.svgis excluded by!**/*.svg,!docs/archive/**docs/archive/study/diagrams/tour-13.mmdis excluded by!docs/archive/**docs/archive/study/diagrams/tour-13.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/diagrams/tour-13.svgis excluded by!**/*.svg,!docs/archive/**docs/archive/study/diagrams/tour-14.mmdis excluded by!docs/archive/**docs/archive/study/diagrams/tour-14.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/diagrams/tour-14.svgis excluded by!**/*.svg,!docs/archive/**docs/archive/study/diagrams/tour-15.mmdis excluded by!docs/archive/**docs/archive/study/diagrams/tour-15.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/diagrams/tour-15.svgis excluded by!**/*.svg,!docs/archive/**docs/archive/study/echo-tour-de-code-directors-cut.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/echo-tour-de-code-directors-cut.texis excluded by!docs/archive/**docs/archive/study/echo-tour-de-code-with-commentary.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/echo-tour-de-code-with-commentary.texis excluded by!docs/archive/**docs/archive/study/echo-tour-de-code.mdis excluded by!docs/archive/**docs/archive/study/echo-tour-de-code.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/echo-tour-de-code.texis excluded by!docs/archive/**docs/archive/study/echo-visual-atlas-with-diagrams.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/echo-visual-atlas-with-diagrams.texis excluded by!docs/archive/**docs/archive/study/echo-visual-atlas.mdis excluded by!docs/archive/**docs/archive/study/echo-visual-atlas.texis excluded by!docs/archive/**docs/archive/study/extract-mermaid.pyis excluded by!docs/archive/**docs/archive/study/inject-diagrams.pyis excluded by!docs/archive/**docs/archive/study/macros.texis excluded by!docs/archive/**docs/archive/study/paper-7eee.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/paper-7eee.texis excluded by!docs/archive/**docs/archive/study/refs.bibis excluded by!docs/archive/**docs/archive/study/render-tour-diagrams.pyis excluded by!docs/archive/**docs/archive/study/what-makes-echo-tick-processed.mdis excluded by!docs/archive/**docs/archive/study/what-makes-echo-tick-with-diagrams.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/what-makes-echo-tick-with-diagrams.texis excluded by!docs/archive/**docs/archive/study/what-makes-echo-tick.mdis excluded by!docs/archive/**docs/archive/study/what-makes-echo-tick.pdfis excluded by!**/*.pdf,!docs/archive/**docs/archive/study/what-makes-echo-tick.texis excluded by!docs/archive/**docs/archive/tasks.mdis excluded by!docs/archive/**docs/archive/tasks/TASKS.mdis excluded by!docs/archive/**docs/archive/tasks/WASM-TASKS.mdis excluded by!docs/archive/**docs/archive/tasks/issue-canonical-f32.mdis excluded by!docs/archive/**docs/archive/telemetry-graph-replay.mdis excluded by!docs/archive/**docs/archive/testing-and-replay-plan.mdis excluded by!docs/archive/**docs/archive/two-lane-abi.mdis excluded by!docs/archive/**docs/archive/warp-demo-roadmap.mdis excluded by!docs/archive/**docs/archive/warp-runtime-architecture.mdis excluded by!docs/archive/**docs/assets/dags/tasks-dag.dotis excluded by!**/*.dotdocs/assets/dags/tasks-dag.svgis excluded by!**/*.svg
📒 Files selected for processing (88)
.gitignoreREADME.mddocs/DETERMINISTIC_MATH.mddocs/ROADMAP.mddocs/ROADMAP/ISSUE-INDEX.mddocs/ROADMAP/STATUS_DEFINITIONS.mddocs/ROADMAP/backlog/README.mddocs/ROADMAP/backlog/deterministic-rhai.mddocs/ROADMAP/backlog/editor-hot-reload.mddocs/ROADMAP/backlog/git-mind-nexus.mddocs/ROADMAP/backlog/importer.mddocs/ROADMAP/backlog/plugin-abi.mddocs/ROADMAP/backlog/security.mddocs/ROADMAP/backlog/signing-pipeline.mddocs/ROADMAP/backlog/tooling-misc.mddocs/ROADMAP/backlog/ttd-hardening.mddocs/ROADMAP/backlog/wesley-boundary-grammar.mddocs/ROADMAP/backlog/wesley-docs.mddocs/ROADMAP/backlog/wesley-future.mddocs/ROADMAP/deep-storage/README.mddocs/ROADMAP/deep-storage/api-evolution.mddocs/ROADMAP/deep-storage/disk-tier.mddocs/ROADMAP/deep-storage/gc-sweep-eviction.mddocs/ROADMAP/deep-storage/wire-protocol.mddocs/ROADMAP/developer-cli/README.mddocs/ROADMAP/developer-cli/bench.mddocs/ROADMAP/developer-cli/cli-scaffold.mddocs/ROADMAP/developer-cli/docs-man-pages.mddocs/ROADMAP/developer-cli/inspect.mddocs/ROADMAP/developer-cli/verify.mddocs/ROADMAP/first-light/README.mddocs/ROADMAP/first-light/browser-visualization.mddocs/ROADMAP/first-light/echo-cas-browser.mddocs/ROADMAP/first-light/echo-wesley-gen-v2.mddocs/ROADMAP/first-light/sha256-blake3.mddocs/ROADMAP/first-light/wasm-runtime.mddocs/ROADMAP/first-light/wesley-go-public.mddocs/ROADMAP/first-light/wesley-migration.mddocs/ROADMAP/first-light/wesley-qir-phase-c.mddocs/ROADMAP/first-light/wesley-type-pipeline-browser.mddocs/ROADMAP/lock-the-hashes/README.mddocs/ROADMAP/lock-the-hashes/benchmarks-cleanup.mddocs/ROADMAP/lock-the-hashes/domain-separated-hashes.mddocs/ROADMAP/proof-core/README.mddocs/ROADMAP/proof-core/determinism-torture.mddocs/ROADMAP/proof-core/deterministic-trig.mddocs/ROADMAP/proof-core/docs-polish.mddocs/ROADMAP/proof-time-convergence/README.mddocs/ROADMAP/proof-time-convergence/worldline-convergence.mddocs/ROADMAP/splash-guy/README.mddocs/ROADMAP/splash-guy/controlled-desync.mddocs/ROADMAP/splash-guy/course-material.mddocs/ROADMAP/splash-guy/lockstep-protocol.mddocs/ROADMAP/splash-guy/rules-and-state.mddocs/ROADMAP/splash-guy/visualization.mddocs/ROADMAP/time-semantics-lock/README.mddocs/ROADMAP/time-semantics-lock/time-model-spec.mddocs/ROADMAP/time-travel/README.mddocs/ROADMAP/time-travel/rulial-diff.mddocs/ROADMAP/time-travel/streams-inspector.mddocs/ROADMAP/time-travel/time-travel-mvp.mddocs/ROADMAP/tumble-tower/README.mddocs/ROADMAP/tumble-tower/course-material.mddocs/ROADMAP/tumble-tower/desync-breakers.mddocs/ROADMAP/tumble-tower/lockstep-harness.mddocs/ROADMAP/tumble-tower/stage-0-aabb.mddocs/ROADMAP/tumble-tower/stage-1-rotation.mddocs/ROADMAP/tumble-tower/stage-2-friction.mddocs/ROADMAP/tumble-tower/stage-3-sleeping.mddocs/ROADMAP/tumble-tower/visualization.mddocs/SPEC_DETERMINISTIC_MATH.mddocs/architecture-outline.mddocs/assets/dags/tasks-dag-source.mddocs/dependency-dags.mddocs/guide/eli5.mddocs/guide/start-here.mddocs/index.mddocs/meta/README.mddocs/meta/docs-audit.mddocs/meta/docs-index.mddocs/meta/legacy-excavation.mddocs/public/collision-dpo-tour.htmldocs/workflows.mdscripts/check-append-only.jsscripts/generate-dependency-dags.jsscripts/generate-tasks-dag.jstests/hooks/test_dependency_dags.shxtask/src/main.rs
💤 Files with no reviewable changes (15)
- docs/ROADMAP/backlog/README.md
- docs/DETERMINISTIC_MATH.md
- docs/ROADMAP/STATUS_DEFINITIONS.md
- docs/ROADMAP/proof-core/README.md
- docs/ROADMAP/deep-storage/README.md
- docs/ROADMAP/proof-time-convergence/README.md
- docs/ROADMAP/ISSUE-INDEX.md
- docs/ROADMAP/time-semantics-lock/README.md
- docs/SPEC_DETERMINISTIC_MATH.md
- docs/ROADMAP/tumble-tower/README.md
- docs/ROADMAP/developer-cli/README.md
- docs/ROADMAP/lock-the-hashes/README.md
- docs/ROADMAP/first-light/README.md
- docs/ROADMAP/splash-guy/README.md
- docs/ROADMAP/time-travel/README.md
Contributor
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/architecture-outline.md (1)
20-27:⚠️ Potential issue | 🟠 MajorResolve determinism guarantee drift across this document.
Line 26 uses implementation-aligned wording, but this file still asserts “bit-exact” guarantees elsewhere (Line 153, Line 217). Keep one contract language throughout, or this section becomes internally contradictory on determinism strength.
Use the same “deterministic + canonical” guarantee phrasing consistently unless you can prove byte-identical output guarantees end-to-end.
As per coding guidelines: “Documentation accuracy matters — especially anything touching determinism guarantees, hash stability, or canonical ordering. Flag factual errors and stale cross-references.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/architecture-outline.md` around lines 20 - 27, The document uses conflicting determinism wording (e.g., the "warp-core rewrite engine" bullet and the phrases "bit-exact" at other spots), so pick a single contract phrase—preferably "deterministic + canonical" unless you can justify and prove end-to-end byte-identical output—and update all occurrences to match; specifically search for and replace "bit-exact" and any variant instances around the "warp-core rewrite engine", "Playback / worldlines / provenance", "Renderer / scene boundary", and "TTD / browser tooling substrate" sections (and the surrounding headings) so the file consistently states the chosen determinism guarantee or add a short note where bit-exactness is provably guaranteed with references.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/architecture-outline.md`:
- Around line 20-27: The document uses conflicting determinism wording (e.g.,
the "warp-core rewrite engine" bullet and the phrases "bit-exact" at other
spots), so pick a single contract phrase—preferably "deterministic + canonical"
unless you can justify and prove end-to-end byte-identical output—and update all
occurrences to match; specifically search for and replace "bit-exact" and any
variant instances around the "warp-core rewrite engine", "Playback / worldlines
/ provenance", "Renderer / scene boundary", and "TTD / browser tooling
substrate" sections (and the surrounding headings) so the file consistently
states the chosen determinism guarantee or add a short note where bit-exactness
is provably guaranteed with references.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 4e66bc97-48d8-49ed-ae86-dbb63013d339
📒 Files selected for processing (4)
docs/architecture-outline.mddocs/index.mddocs/public/collision-dpo-tour.htmlscripts/generate-dependency-dags.js
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/ROADMAP/backlog/tooling-misc.md`:
- Line 804: Update the checklist item text for AC4 by replacing "collision-tour
style regression class" with the hyphenated compound "collision-tour-style
regression class" so the line reads: "AC4: The collision-tour-style regression
class is caught before review"; edit the string where it appears (the checklist
item containing "AC4: The collision-tour style regression class is caught before
review") to apply the hyphenation.
🪄 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: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 836ec3bf-0df5-4c4c-870e-737e10792d54
📒 Files selected for processing (1)
docs/ROADMAP/backlog/tooling-misc.md
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/ROADMAP/backlog/tooling-misc.md`:
- Around line 789-803: The docs validation currently only checks
docs/public/*.html which misses nested HTML entrypoints; update the validation
glob to a recursive pattern (e.g., docs/public/**/*.html) wherever the pattern
appears (CI/job config, validation scripts, and any function or variable named
like "docs validation lane", "docs validation", or the command documented for
contributors) and update the acceptance criteria/README text so AC1 explicitly
references the recursive pattern and the one documented local check command (the
contributors’ command) to ensure it covers nested live HTML files.
🪄 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: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 9698bbc0-f9ee-4262-83a0-5400697ffabe
📒 Files selected for processing (2)
CHANGELOG.mddocs/ROADMAP/backlog/tooling-misc.md
Comment on lines
+789
to
+803
| - R1: Expand docs validation so it covers `docs/public/*.html` and any other | ||
| live non-Markdown docs entrypoints | ||
| - R2: Add static-HTML link and asset checks for repo-local routes and | ||
| references | ||
| - R3: Keep the lane scoped enough that docs-only changes remain fast to verify | ||
| - R4: Document exactly which doc surfaces are covered and which are still | ||
| intentionally excluded | ||
|
|
||
| **Acceptance Criteria:** | ||
|
|
||
| - [ ] AC1: A broken local route or asset reference in `docs/public/*.html` | ||
| fails the docs validation lane | ||
| - [ ] AC2: Docs validation is no longer effectively Markdown-only | ||
| - [ ] AC3: Contributors can run one documented command to check the covered docs | ||
| surfaces locally |
Contributor
There was a problem hiding this comment.
Validation scope is too narrow with docs/public/*.html.
Using a single-level glob risks missing nested live HTML entrypoints, which undermines the stated goal in Line 789 (“real docs surface”). Make the scope recursive and explicit.
Proposed doc fix
-- R1: Expand docs validation so it covers `docs/public/*.html` and any other
+- R1: Expand docs validation so it covers `docs/public/**/*.html` and any other
live non-Markdown docs entrypoints
...
-- [ ] AC1: A broken local route or asset reference in `docs/public/*.html`
+- [ ] AC1: A broken local route or asset reference in `docs/public/**/*.html`
fails the docs validation lane🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/ROADMAP/backlog/tooling-misc.md` around lines 789 - 803, The docs
validation currently only checks docs/public/*.html which misses nested HTML
entrypoints; update the validation glob to a recursive pattern (e.g.,
docs/public/**/*.html) wherever the pattern appears (CI/job config, validation
scripts, and any function or variable named like "docs validation lane", "docs
validation", or the command documented for contributors) and update the
acceptance criteria/README text so AC1 explicitly references the recursive
pattern and the one documented local check command (the contributors’ command)
to ensure it covers nested live HTML files.
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
1 participant
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 PR cuts the live docs surface instead of adding more meta-docs.
It does two passes:
What changed
docs/archive/from the live treedocs/meta/docs/assets/dags/tasks-dag-source.mddocs/index.mddocs/architecture-outline.mdso it leads with what exists todaydocs/workflows.mdby dropping stale archive-driven handoff guidancedocs/ROADMAP.mdinto the single roadmap entrypointREADME.mdwrappers plus roadmap status/index sidecarsVerification
bash tests/hooks/test_dependency_dags.shcargo test -p xtaskcargo xtask lint-dead-refs --root docspnpm exec markdownlint-cli2 ...on changed docsfmt,guards,hook-testsIntent
The goal is not to perfect docs in one PR. The goal is to make the live docs tree feel intentional again:
mainSummary by CodeRabbit