docs: upgrade VitePress to 1.6.4 #213
Conversation
|
Warning Rate limit exceeded@flyingrobots has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 24 minutes and 35 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ⛔ Files ignored due to path filters (63)
📒 Files selected for processing (31)
WalkthroughDocumentation formatting standardization across multiple guides and decision logs, VitePress dependency upgrade from 0.1.1 to 1.6.4 for modern Node compatibility, link path corrections to remove file extensions, and addition of new specification stubs and execution plan entries. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~22 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
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
echo/docs/public/collision-dpo-tour.html
Lines 9 to 12 in b65004f
Fix collision tour asset paths after move to public/
After moving collision-dpo-tour.html into docs/public, its CSS and image references still point to ./assets/collision/.... That now resolves to docs/public/assets/..., but the assets are still stored under docs/assets/collision, so the built or dev-served page will 404 the stylesheet and all diagrams, rendering the interactive tour unstyled and without images. Update the relative paths (or relocate the assets) so the public copy can find them.
ℹ️ 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}
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/scheduler-reserve-validation.md (1)
263-263: Double-backtick notation at line 263 — clarify intent.The sequence
`<from>-to-<to>`uses double backticks, which in Markdown renders a literal backtick inside code. The intent appears to be a template notation (placeholder angle brackets), which is typically styled as`<from>-to-<to>`(single backticks around the whole thing) or<from>-to-<to>(no backticks, in prose context).Single backticks are cleaner here:
`<from>-to-<to>`.
📜 Review details
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (14)
docs/benchmarks/RESERVE_BENCHMARK.mddocs/decision-log.mddocs/execution-plan.mddocs/guide/collision-tour.mddocs/index.mddocs/notes/scheduler-radix-optimization-2.mddocs/notes/scheduler-radix-optimization.mddocs/public/collision-dpo-tour.htmldocs/roadmap-mwmr-mini-epic.mddocs/scheduler-reserve-complexity.mddocs/scheduler-reserve-validation.mddocs/spec-geom-collision.mddocs/spec-merkle-commit.mdpackage.json
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: CR
Repo: flyingrobots/echo PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-28T23:14:28.103Z
Learning: When a PR touches non-doc code, update `docs/execution-plan.md` and `docs/decision-log.md` in the same PR.
📚 Learning: 2025-12-28T23:14:28.103Z
Learnt from: CR
Repo: flyingrobots/echo PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-28T23:14:28.103Z
Learning: Start each session by updating *Today's Intent* in `docs/execution-plan.md` and capture milestones, blockers, and decisions in the Decision Log.
Applied to files:
docs/execution-plan.md
📚 Learning: 2025-12-28T23:14:28.103Z
Learnt from: CR
Repo: flyingrobots/echo PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-28T23:14:28.103Z
Learning: When a PR touches non-doc code, update `docs/execution-plan.md` and `docs/decision-log.md` in the same PR.
Applied to files:
docs/execution-plan.mddocs/decision-log.md
📚 Learning: 2025-12-28T23:14:28.103Z
Learnt from: CR
Repo: flyingrobots/echo PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-28T23:14:28.103Z
Learning: Consult `docs/architecture-outline.md` before touching runtime code in packages/echo-core.
Applied to files:
docs/notes/scheduler-radix-optimization.md
🪛 markdownlint-cli2 (0.18.1)
docs/notes/scheduler-radix-optimization.md
446-446: Emphasis style
Expected: underscore; Actual: asterisk
(MD049, emphasis-style)
446-446: Emphasis style
Expected: underscore; Actual: asterisk
(MD049, emphasis-style)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cargo Audit (stable)
🔇 Additional comments (13)
docs/notes/scheduler-radix-optimization.md (1)
446-446: LGTM: Link format standardization for VitePress compatibility.The absolute path format aligns with VitePress's dead-link checking requirements mentioned in the PR objectives.
docs/roadmap-mwmr-mini-epic.md (1)
43-43: LGTM: HTML entity escaping and inline code formatting prevent parsing ambiguities.Line 43 escapes the less-than operator to prevent VitePress from interpreting it as an HTML tag. Line 55's inline code formatting similarly protects the angle-bracketed revision ID syntax. Both changes align with the PR objective to fix angle-bracket/generic-type parsing issues.
Also applies to: 55-55
docs/notes/scheduler-radix-optimization-2.md (1)
277-277: LGTM: File path formatting standardization.Converting the dashboard references from hyperlinks to inline code formatting provides literal path representation and aligns with the broader documentation formatting standardization in this PR.
Also applies to: 336-336
docs/spec-merkle-commit.md (1)
68-68: LGTM: Inline code formatting prevents angle-bracket parsing issues.Wrapping
Vec<Hash>in backticks prevents VitePress from misinterpreting the angle brackets as HTML tag delimiters, addressing the parsing issues noted in the PR objectives.package.json (1)
16-16: No action needed—version pinning to 1.6.4 is appropriate and secure.VitePress 1.6.4 is the latest stable release as of January 2026; VitePress 2.0 remains in alpha/next status. No published security advisories exist for 1.6.4, and Snyk reports no direct vulnerabilities. Pinning to the latest stable version ensures reproducibility without sacrificing currency or security coverage—this is exactly when exact pinning makes sense. The caret removal here is justified.
Likely an incorrect or invalid review comment.
docs/benchmarks/RESERVE_BENCHMARK.md (2)
105-105: Inline code formatting applied correctly.Backticks around
Vec<Footprint>prevent VitePress from misinterpreting generic-type syntax as HTML tags—essential for compatibility with VitePress 1.6.4's stricter parsing.
113-113: Consistent type reference formatting.Type names properly wrapped in backticks across the "Future Work" section, maintaining readability and VitePress compatibility.
docs/scheduler-reserve-complexity.md (1)
77-77: VitePress 1.6.4 parsing safeguards applied correctly.Both the section header and table column header properly escape
Vec<Footprint>with backticks. This prevents ambiguity in VitePress 1.6.4's HTML/Markdown parser and maintains semantic correctness of type references.Also applies to: 119-119
docs/spec-geom-collision.md (1)
1-19: All referenced artifacts are present and properly cross-referenced.Verification confirms:
- ✓
docs/public/collision-dpo-tour.htmlexists- ✓
docs/guide/collision-tour.mdexists- ✓
docs/assets/collision/existsThe spec stub's inventory is accurate. Additional searches reveal the interactive tour is consistently referenced across execution-plan.md, index.md, decision-log.md, and the book source files—confirming active use and no dead links at the documentation layer.
docs/index.md (1)
12-12: Link path formatting aligns with VitePress 1.6.4 conventions.Removing the
.mdextension is correct for internal Markdown-to-Markdown navigation in VitePress 1.6.4; the router handles the extension implicitly.docs/guide/collision-tour.md (1)
11-11: Link text formatting is clear and correct.Code-formatting the reference to the HTML asset path improves readability without affecting routing. The href
/collision-dpo-tour.htmlcorrectly points to the VitePress public asset root.docs/public/collision-dpo-tour.html (2)
1-12: Confirm documentation plan and decision-log updates are included in this PR.Per learnings, when a PR touches non-documentation code (e.g.,
package.json,pnpm-lock.yaml), the PR should also updatedocs/execution-plan.mdanddocs/decision-log.md.The VitePress version bump and lockfile regeneration affect the documentation toolchain. These operational/decision changes should be reflected in those tracking documents.
Please confirm:
- Are
docs/execution-plan.mdanddocs/decision-log.mdupdated in this PR?- If yes, what entries were added or modified?
- If no, should they be updated to reflect the VitePress 1.6.4 upgrade decision and execution progress?
30-30: The absolute path/spec-geom-collisionis correct and requires no changes.The target file
docs/spec-geom-collision.mdexists, and VitePress'scleanUrls: trueconfiguration automatically routes it to/spec-geom-collisionwithout the.mdextension. Static assets indocs/public/are served from the site root, so the absolute path reference is the correct approach here. No fallback relative path is needed.
|
Follow-up: made the VitePress home actually navigable and fixed a frontmatter gotcha.
|
|
Tweaked
|
|
Docs usability pass landed on this PR:
Build check:
vitepress v1.6.4 build complete in 3.35s. is green (still shows the non-fatal Rhai highlight fallback warning). |
|
Corrected summary (previous comment had shell-substitution issues):
Build check: pnpm docs:build is green (still shows the non-fatal Rhai highlight fallback warning). |
|
Added a non-programmer spiral on-ramp and wired it into the docs flow:
Build check: pnpm docs:build is green. |
|
Update addressing latest review notes:
Validation:
Branch is merged with origin/main and pushed for a fresh CodeRabbit pass. |
Signed-off-by: James Ross <james@flyingrobots.dev>
# Conflicts: # docs/decision-log.md # docs/execution-plan.md # docs/scheduler-reserve-complexity.md # docs/scheduler-reserve-validation.md # docs/scheduler.md
Closes #212
Summary:
vitepress@0.1.1tovitepress@1.6.4and regeneratepnpm-lock.yaml.Verification:
pnpm docs:build(green)Notes:
rhailanguage is not loaded for syntax highlighting (falls back totxt). This is warning-only.