Templates

Template for endpoint documentation — method, path, authentication, parameters, request body, response schema, and code examples. Use for every endpoint in your API reference.

Task-based guide template with prerequisite checklist, numbered steps, expected outputs, and a troubleshooting section. Focused on a single, specific user goal.

Template for conceptual pages — the "what" and "why" behind a feature or system. Covers definitions, mental models, diagrams, and links to related task documentation.

Versioned changelog template for communicating product changes — new features, improvements, bug fixes, deprecations, and breaking changes. One file per release or one H2 per release.