Page Templates

Copy one of these and keep moving

These are defaults, not rules. Use the smallest shape that helps you make progress.

---
title: Topic Name
description: One sentence saying what the reader will learn here.
---

## Why this matters

Explain the concept in plain language.

## Current model

- state the main idea
- name the key actors
- note the important tradeoffs

## What to fill in next

- open questions
- missing examples
- links to related pages

---
title: Runbook Name
description: The repeatable task this page helps someone complete.
tableOfContents: false
---

## Preconditions

- what must be true before starting

## Steps

1. Do the first action.
2. Verify the result.
3. Continue only if the check passes.

## Rollback

- how to undo the change safely

## Notes

- links to dashboards, logs, or related pages

---
title: Reference Topic
description: A terse lookup page for a stable concept or structure.
---

## Definition

Short, direct explanation.

## Fields or parts

- `field_one`: what it means
- `field_two`: when to use it

## Gotchas

- short facts with little narrative

---
title: MDX Topic
description: Use MDX when components make the page easier to scan.
---

import { Card, CardGrid, Steps } from '@astrojs/starlight/components';

## Overview

<CardGrid>
  <Card title="Why MDX here">
    Components help when structure matters more than a long prose block.
  </Card>
</CardGrid>

## Procedure

<Steps>

1. Explain the first action.
2. Explain the validation step.

</Steps>

Frontmatter fields worth learning first

title: required page title
description: short summary for readers and metadata
template: use splash for wide landing pages, otherwise leave the default doc
tableOfContents: useful to disable on checklists and short runbooks
editUrl: set to false when a page should not show an edit link
sidebar.badge: handy for labels like new, draft, or stub

Open the component showcase