Skip to content

Documentation Guide

The documentation site is built with:

  • Astro 7.x — Static site generator
  • Starlight 0.41.x — Documentation theme
  • Pagefind — Full-text search
  • Markdown/MDX — Content format
Terminal window
cd docs_site
npm install
npm run dev

The development server starts at http://localhost:4321.

  1. Create a .md or .mdx file in the appropriate directory under src/content/docs/
  2. Add frontmatter:
---
title: My New Page
description: Brief description for SEO.
---
  1. If the page should appear in the sidebar, add it to astro.config.mjs in the sidebar array
Field Required Description
title Yes Page title (also used in sidebar)
description Yes Meta description for SEO
sidebar No Custom sidebar label (defaults to title)
src/content/docs/
├── index.mdx # Home page (splash layout)
├── getting-started/ # Getting started guides
├── tutorials/ # Step-by-step tutorials
├── api-reference/ # API documentation
├── advanced/ # Advanced guides
├── deployment/ # Deployment guides
├── security/ # Security documentation
├── observability/ # Observability docs
├── reference/ # Reference docs
├── contributing/ # Contributor guides
└── examples/ # Example gallery
  • Use # for page title (H1), ## for sections (H2), ### for subsections (H3)
  • Code blocks should specify language for syntax highlighting: ```python
  • Use relative links to other docs pages: [Text](/getting-started/overview/)
  • All code examples should be tested before committing
Terminal window
npm run build # Output in dist/
npm run preview # Preview the built site