Documentation Guide
Tech Stack
Section titled “Tech Stack”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
Local Development
Section titled “Local Development”cd docs_sitenpm installnpm run devThe development server starts at http://localhost:4321.
Adding a New Page
Section titled “Adding a New Page”- Create a
.mdor.mdxfile in the appropriate directory undersrc/content/docs/ - Add frontmatter:
---title: My New Pagedescription: Brief description for SEO.---- If the page should appear in the sidebar, add it to
astro.config.mjsin thesidebararray
Page Frontmatter
Section titled “Page Frontmatter”| 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) |
Directory Structure
Section titled “Directory Structure”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 galleryConventions
Section titled “Conventions”- 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
Building
Section titled “Building”npm run build # Output in dist/npm run preview # Preview the built siteSee Also
Section titled “See Also”- Development Setup — Get started
- Coding Standards — Code conventions
- Testing Guide — Writing tests