Skip to content

Docs templates

Use these templates for new pages to keep the site consistent and scannable.

Tutorial template

---
tags:
  - tutorial
  - <topic>
---

# Tutorial: <title>

## Who this is for

- ...

## What you will get

- ...

## Prereqs

- ...

## Steps

## Verify (Definition of Done)

- [ ] ...

## Troubleshooting

- ...

## Read next

- ...

How-to template

---
tags:
  - how-to
  - <topic>
---

# <task name>

## Who this is for

- ...

## What you will get

- ...

## Steps

## Verify

- [ ] ...

## Read next

- ...

Reference template

---
tags:
  - reference
  - <topic>
---

# <thing name>

## Purpose

## Schema / contract

## Examples

## Compatibility notes

## Read next

Explanation template

---
tags:
  - explanation
  - <topic>
---

# <concept name>

## Problem

## Why this exists

## How it works (mental model)

## Tradeoffs

## Read next