Writing a guide
How to add a new guide to the knowledge base.
Writing a guide
Creating a guide takes one file. No code changes required.
1. Add a Markdown file
Create a file under content/guides/, for example
content/guides/exporting-data.md:
---
title: Exporting your data
description: Download your data as CSV or JSON.
order: 20
---
# Exporting your data
Steps go here…
2. Front-matter fields
| Field | Required | Purpose |
|---|---|---|
title | yes | Heading, navigation label and <title> |
description | no | SEO meta + search snippet |
screen | no | Ties the guide to an app screen for contextual help |
order | no | Sort weight within the navigation (lower first) |
3. That's it
On the next build the guide appears in navigation, search and at its own URL
(/guides/exporting-data). Markdown supports headings, tables, code blocks and
MDC components.