Skip to main content

Our Reading Guide

Type: ExplanationCreated: Last reviewed: Team: Platform
published

What this handbook is​

The engineering team's handbook - how we code, what we built, how we run it, and how we write about all of the them. Only engineering content lives here; everything else lives in other tools.

How to find a doc​

Three ways, in the order most people use them:

  • Search — keywords, phrases, or related ideas. The search understands meaning, not just exact words, so close matches still surface.
  • Chatbot — natural-language questions. Answers are grounded in the docs and cite their sources.
  • Browse — when you know roughly where it lives. The sidebar follows the same shape across the whole handbook.

Helpful features​

Things that make reading easier:

  • Audio reader — click the play icon next to any heading to listen.
  • On this page — the right sidebar shows the doc's outline. Click to jump to a section.
  • Copy code — every code block has a copy button.
  • Copy a section link — hover a heading and click the chain icon to copy a direct link.
  • Image zoom — click any image to enlarge it.
  • Theme — switch between light, dark, or auto (matches your system) using the toggle in the top-right.

What doc type tells you​

Every doc has a doc_type at the top. It tells you how to read it — scan a Reference, follow a Tutorial, study an Explanation. See Pick the Right Doc Type for the full list.

What status tells you​

Every doc has a status at the top. It tells you how fresh the content is — Published is current, Draft and Review are works-in-progress, Deprecated is old or replaced. See The Doc Lifecycle.

When a doc is wrong or you have any questions to ask​

Every doc has an owner_team at the top. Ask more from that team or File an issue against that team — they're on the hook to help you or for the fix. If a doc has no owner, flag it as a bug.