Writing Docs
Add a new documentation page and control where it appears in the sidebar.
A doc is just an MDX file in src/content/docs/ with frontmatter. The filename becomes the URL slug — installation.mdx is served at /docs/installation.
Create a page
Add a file and give it frontmatter:
---
title: Rate Limits
description: How request quotas work and how to raise them.
group: Reference
order: 2
---
Your content goes here, in **MDX**.Save it, and it appears in the sidebar under Reference, in the search index, and in the prev/next navigation — automatically.
Frontmatter fields
| Field | Required | Description |
|---|---|---|
title | yes | Page heading, <title>, and default nav label |
description | yes | Shown under the title and in search/meta |
group | yes | Sidebar group (see Configuring the Sidebar) |
order | no | Sort order within the group (lower = higher) |
sidebar | no | Shorter label for the sidebar nav |
draft | no | When true, the page is excluded from the build |
Headings and the TOC
The right-hand “On this page” table of contents is generated from your ## and ### headings. Use them to structure long pages — Beacon handles anchor links and scroll-spy styling for you.
Drafts
Set draft: true to keep a work-in-progress page out of the build, sidebar, and search until it’s ready:
---
title: Webhooks
description: Receive real-time events.
group: Guides
draft: true
---Next: control nav grouping in Configuring the Sidebar.