3.5 KiB

Documentation site and runnable examples

Use this topic for guides, API references, navigation, themes, legacy links, and interactive examples. Development and preview commands are in the documentation-site README.

Question Read first Follow through
Public usage, APIs, and compatibility migrations Developer guides, API reference, migration guide Application/documentation coordination, shared package boundaries
Site theme, navigation, and source links VitePress configuration, sidebar, theme Version and repository links
Legacy documentation paths and redirects Legacy path mapping Combined site and legacy redirect artifacts, build and deployment
Inline interaction and source inclusion Lightweight Vue examples, admin iframe wrapper example.html, isolated demo bootstrap and routes, admin demo pages

Lightweight examples use public shared-package entry points. Examples needing application context use the restricted routes and in-memory cache in example.html. Display the same source that actually runs. For public contract changes, return to the owning topic and update guides, examples, and migration notes.

Targeted verification: pnpm harness verify docs runs docs:check, covering types, internal links, and the production build. Wording-only corrections can use source review and formatting checks. Use a browser only for affected rendering or interactions, selecting the relevant page/example and dimensions through the documentation workflow. For admin embedding, deployment subpaths, or combined redirect artifacts, generate the combined output with pnpm pages:build and preview it as described in the README.