How Our Docs Work
Type: ExplanationCreated: Last reviewed: Team: Platform
published
What this section is
This section is about the handbook itself — how it's written, structured, and read. It's for everyone who uses the handbook, whether you're reading docs or writing them.
What's here
- Our Reading Guide — how to navigate, search, and read effectively
- The Doc Lifecycle — what Draft, Review, Published, and Deprecated mean on a page
- Pick the Right Section — the six sections the handbook is organized into
- Pick the Right Doc Type — the seven doc types and what each is for
- Pick the Right Team — the four teams that own docs
- Fill the Frontmatter — the metadata block every doc carries
- The Audio Layer — authoring the on-page narration (evolving with the editor)
- Write Your First Doc — placeholder; lands with the editor's authoring flow
- The Review Process — placeholder; lands with the editor-workflows section
- What the Validator Checks — every rule the validator enforces, and what blocks a save
- Markdown Features — placeholder; lands with the editor's markdown surface
- Templates — starting points for every doc type
What's NOT here
Everything about the product, the system, and how we build it lives in the other sections — see Pick the Right Section.
Who owns this
Platform team.