Appearance
Documentation maintenance
Local development
bash
npm install
npm run dev:docsBuild
bash
npm run docs:api
npm run build:docs
npm run preview:docsAdding a page
- Create a Markdown file under
apps/docs. - Add it to the matching sidebar in
.vitepress/config.mts. - Add live examples only through client-only components.
- Verify code against the public package entry point.
- Add cross-links from related concept and API pages.
Updating API docs
Public TypeScript symbols should have JSDoc comments. Run TypeDoc after changing exports. Handwritten pages remain the source for workflows; generated output is the signature-level source.
Link and example review
Before release, search for the placeholder package scope and deployment hostname, then replace them with real project values.