Skip to content

Documentation maintenance

Local development

bash
npm install
npm run dev:docs

Build

bash
npm run docs:api
npm run build:docs
npm run preview:docs

Adding a page

  1. Create a Markdown file under apps/docs.
  2. Add it to the matching sidebar in .vitepress/config.mts.
  3. Add live examples only through client-only components.
  4. Verify code against the public package entry point.
  5. 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.

Before release, search for the placeholder package scope and deployment hostname, then replace them with real project values.

Released under the MIT License.