Authoring Docs

Docs are plain Markdown files managed by Astro Starlight.

Add A Page

Create a Markdown file in src/content/docs/docs/:

src/content/docs/docs/my-note.md

The page will be available at:

/docs/my-note/

Every page needs frontmatter:

---
title: My Note
description: A short sentence describing the page.
---

Add It To Navigation

Update the sidebar array in astro.config.mjs.

Use the Starlight slug without leading or trailing slashes:

{ slug: 'docs/my-note' }

Writing Style

• Prefer short pages with one clear job.
• Use concrete headings.
• Put implementation paths in backticks.
• Link back to the homepage or related docs when it helps orientation.
• Keep design decisions in DESIGN.md and summarize them in docs only when useful.

Local Check

Run a build after changing docs:

npm run build

The build validates Starlight frontmatter, links, routes, and generated content.