Skip to content

Documentation Site

The documentation site is an Astro Starlight project at the repository root. It loads Markdown and MDX files from their existing locations instead of requiring a separate docs source tree.

Content Sources

The docs content collection loads:

  • README.md
  • docs/**/*.{md,mdx}
  • package and component README.md files under existing project directories

Route IDs are generated from repository-relative source paths. The root README.md becomes the site index, and nested README.md files use their parent directory path.

Commands

Install dependencies:

Terminal window
npm install

Run the local development server:

Terminal window
npm run dev

Build the static site, Pagefind search index, and LLM text files:

Terminal window
npm run build

Validate the documentation site in CI:

Terminal window
npm run validate

Preview the built site locally:

Terminal window
npm run preview

The build publishes docs-dist/, including llms.txt, llms-full.txt, and the Pagefind search index.