Fill the Frontmatter
Type: ReferenceCreated: Last reviewed: Team: Platform
published
Why frontmatter matters
A YAML block at the top of every doc — required because it's what makes the handbook searchable, ownable, and self-checking.
The fields
| Field | Required | Meaning |
|---|---|---|
title | yes | Human-readable. Not the filename. |
description | yes | One sentence, 20–200 chars. Shown in search. |
doc_type | yes | Slug from shared/doc-types.ts. See Pick the Right Doc Type. |
owner_team | yes | Slug from shared/teams.ts. Never a person. See Pick the Right Team. |
status | yes | draft, review, published, or deprecated. See The Doc Lifecycle. |
created | yes | ISO date when first written. Treat as historical. |
last_reviewed | no | ISO date when last confirmed correct. Drives the freshness gradient. |
Example
---
title: How User Authentication Works
description: How sign-in, sessions, and tokens fit together.
doc_type: explanation
owner_team: engineering
status: published
created: 2025-09-12
last_reviewed: 2026-01-15
---