docs: migrate from VitePress to Scalar Docs - #8
Open
yanboishere wants to merge 4 commits into
Open
Conversation
yanboishere
force-pushed
the
docs/migrate-to-scalar
branch
from
September 9, 2026 07:41
5476ed5 to
7d4de9c
Compare
Align the language/version selector to the right side of the header, next to the GitHub link, using Scalar's native version-selector header entry with align: end. Applied to both the English (default) and Chinese (zh) versions, and fixed in scripts/build-config.py so the change survives config regeneration.
- Merge guides/integrations/self-hosted into a single References section with Getting Started / Advanced / Use Cases subgroups - Trim use-cases page to a minimal placeholder (EN+ZH) - Add per-page 'Edit on GitHub' link via injected head script - Regenerate Scalar config (62 redirects, edit-link map)
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
Migrate the docs site from VitePress to Scalar Docs, based on the latest
main(already includes the Quick Start guide, source-sync cleanup, and unified应用市场terminology from #7). Also restructures the navigation into a single References tree and adds per-page "Edit on GitHub" links.What changed
1. Framework migration (VitePress → Scalar Docs)
.vitepress/, Vue theme components, and all 88 VitePress redirect stubs.docs/en/anddocs/zh/.scalar.config.jsonrewritten to the multi-version schema (versions: default | zh) — this is what Scalar CLI's preview converter actually consumes, fixing the empty-preview bug.docs/footer.html; removed Vue deps (vitepress,vue).validate-docs.yml/ deploy) runsscalar project check-config+ link check on Node 24.2. Navigation restructure → single "References" tree
/guides/...,/integrations/...,/self-hosted/...) keep working.3. UX polish
4. Tooling
scripts/build-config.py: single source of truth for the sidebar; emits theversionsschema, the 62 redirects, and the edit-link URL→file map.scripts/check-links.py: nowversions-aware (previously flagged all 102 pages as orphan).Verification
scalar project check-config→ SUCCESSpython3 scripts/check-links.py→102 pages, 102 listed, 0 problemsbuild-config.pyis byte-identical to the committed config (no drift)Notes
Supersedes #6: that PR is based on an older
main(before #7 merged), so it is missing the Quick Start guide, the source-sync cleanup (removed heartbeat/plugins/sqlite/kata/qdrant pages), and the应用市场terminology. This branch carries all of that and fixes the empty-preview issue.