refactor(docs): switch to VitePress Plus theme with multi-version builds - #6010
Conversation
|
🤖 Finished Review · ✅ Success · Started 1:59 PM UTC · Completed 2:19 PM UTC Commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
ReviewFindingsMedium
Low
Next steps:
Previous runReviewFindingsMedium
Low
Previous run (2)ReviewFindingsMedium
Low
Next steps:
Previous run (3)ReviewFindingsMedium
Low
Next steps:
Previous run (4)ReviewFindingsMedium
Low
Next steps:
Previous run (5)ReviewFindingsMedium
Low
Next steps:
Previous run (6)ReviewFindingsHigh
Medium
Low
Next steps:
Previous run (7)ReviewFindingsMedium
Low
Previous run (8)ReviewFindingsMedium
Low
Labels: PR modifies .github/workflows/site-build.yml (CI pipeline for doc builds) Previous run (9)ReviewFindingsMedium
Low
Previous run (10)ReviewFindingsMedium
Low
Previous run (11)ReviewFindingsMedium
Low
Next steps:
Previous run (12)ReviewFindingsMedium
Low
Previous run (13)ReviewFindingsHigh
Medium
Low
Next steps:
Previous run (14)ReviewFindingsHigh
Medium
Low
Next steps:
Previous run (15)ReviewFindingsHigh
Medium
Low
Labels: PR modifies VitePress documentation infrastructure and adds multi-version doc support. Next steps:
|
399214e to
30dffbb
Compare
|
🤖 Review · Commit: |
Not true, it resolves correctly as far as I can see ( |
30dffbb to
0b09c0f
Compare
Done |
|
🤖 Review · Commit: |
Done |
0b09c0f to
871c3a6
Compare
|
🤖 Review · Commit: |
871c3a6 to
2bbad0d
Compare
Everything working well, so no problem here. |
It does handle escaping, but not everything weird we may throw at it. We need to scape those strings and there are not even that many. Rejected. |
|
🤖 Review · Commit: |
2bbad0d to
a6f53d7
Compare
|
🤖 Review · ❌ Terminated · Started 7:59 AM UTC · Ended 8:19 AM UTC Commit: |
Site previewPreview: https://cef2cd01-site.fullsend-ai.workers.dev Commit: |
|
🤖 Finished Review · ✅ Success · Started 7:59 AM UTC · Completed 8:19 AM UTC Commit: |
|
🤖 Review · ❌ Terminated · Started 8:46 AM UTC · Ended 9:03 AM UTC Commit: |
PR Summary by QodoDocs: adopt VitePress Theme+ with multi-version builds (mvb)
AI Description
Diagram
High-Level Assessment
Files changed (13)
|
Code Review by Qodo
1.
|
Rescinding: verified the built preview with playwright-cli and the sidebar version label renders the raw 40-char head SHA instead of a version, and it is not preview-only — it will follow to production after merge. Details: #6010 (comment)
bc63d66 to
512d332
Compare
|
@waynesun09 inspecting the code looks like the theme rewrites package.json on the temporal folder with a correct version, so the right move is to retrieve the version from package.json, even if we don't set it. I also added cache stuff. |
|
🤖 Review · Commit: |
512d332 to
98ad03d
Compare
|
🤖 Review · Commit: |
98ad03d to
809fdb5
Compare
|
🤖 Finished Review · ✅ Success · Started 7:33 AM UTC · Completed 7:51 AM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $7.36 |
|
🤖 Finished Review · ✅ Success · Started 2:44 PM UTC · Completed 3:03 PM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $6.02 |
|
🤖 Finished Review · ✅ Success · Started 7:13 AM UTC · Completed 7:54 AM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $7.97 |
Replace the default VitePress theme with @lando/vitepress-theme-default-plus and enable multi-version documentation builds via mvb. Adopt the Lando defineConfig wrapper, add multiVersionBuild/sidebarEnder configuration, derive the sidebar version label from VPL_MVB_VERSION, simplify Vite resolve aliases with import.meta.resolve, and update CI to fetch tags for version discovery. Rework custom CSS for the new theme and preserve -webkit- vendor prefixes for Safari compatibility. Signed-off-by: Hector Martinez <hemartin@redhat.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Hector Martinez <hemartin@redhat.com>
|
🤖 Finished Review · ✅ Success · Started 8:31 AM UTC · Completed 9:11 AM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $7.29 |
There was a problem hiding this comment.
Note: The following review comments could not be posted on the diff (GitHub returned 422) and are included here instead:
.github/workflows/site-build.yml(file-level): Line 1 · [medium] scope-vs-authorization
The workflow uses path filters (on.push.paths and on.pull_request.paths) but does not include merge_group: as a trigger. Per docs/contributing/ci-workflows.md, path-filtered workflows must include merge_group: with a path-relevance guard step. This is a pre-existing gap not introduced by this PR, but surfaced because the PR modifies the workflow.
Suggested fix: Add merge_group: to the on: triggers and add a path-relevance guard step.
docs/.vitepress/theme/components/Mermaid.vue(file-level): Line 58 · [low] incomplete-formatting-within-file
Most of Mermaid.vue reformatted to double-quote + semicolon style, but the openLightbox and onFigureClick functions still use single quotes and omit semicolons.
Suggested fix: Run prettier on the whole file.
|
🤖 Finished Retro · ✅ Success · Started 12:11 PM UTC · Completed 12:21 PM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $1.88 |
Retro: PR #6010 — VitePress Plus theme with multi-version buildsTimelinePR #6010 was a human-authored (rh-hemartin, co-authored with Claude) documentation infrastructure PR that replaced the default VitePress theme with
What went well
Gaps identified
Autonomy assessmentThe agent cannot safely approve docs infrastructure migrations autonomously. Human reviewers were essential: waynesun09 caught the build-breaking preprocessor removal, the version range mismatch, and the Safari prefix regression — none of which the agent detected. For pure CI workflow analysis (merge_group triggers, fetch-depth requirements, protected-path flags), the agent performed at or above human level. Proposals filed |
Summary
Closes #5717
@lando/vitepress-theme-default-plus, which provides built-in multi-version doc support via git-tag discovery and themvbCLIescapeVueSyntaxmarkdown preprocessor for most pages; skip it only forv/index.mdso Theme+ Vue components on that page can compiledocs/v/index.mdand a sidebar version switcherimport.meta.resolveinstead of manualpath.resolvechainsTest plan
npm run docs:devstarts without errors and renders the site with green brandingnpm run docs:buildcompletes (mvb discovers tags and builds versioned output){{ }}and non-HTML<tags>in markdown render correctly withescapeVueSyntaxstill applied (exceptv/index.md)/v/versions page lists discovered tags🤖 Generated with Claude Code