Documentation

Page Templates

Every new documentation page starts from a template. Templates give each page type a proven structure — you pick one in the creation dialog, preview it, and adjust the content afterwards like any other page. Organizations can add their own templates on top of the built-in set.

Choosing a template

  1. In the content tree, choose New Page and pick a page type.
  2. For custom pages, enter a Title and optional Slug first; specialized types go straight to the template step.
  3. In the Choose a Template dialog, select a template on the left and check the live Preview on the right. The Blank option shows "Empty page — start writing from scratch."
  4. Click Create Page.
The template picker with the template list and content preview

Built-in templates

Custom pages

Template Description
Blank Start with an empty page
API Guide Step-by-step API integration guide
Migration Guide Guide for API version migration
FAQ Frequently asked questions
Tutorial Hands-on tutorial with examples

Specialized page types

Each specialized page type ships with three variants:

Page type Templates
Getting Started Standard (full guide with SDK setup and first API call) · Quickstart (minimal, single curl example) · Full Tutorial (multiple languages, SDK setup, error handling)
Authentication Standard (all auth methods with best practices) · API Key Only · OAuth 2.0 Focus (detailed flow with token refresh)
Environments Standard (environment listing with notes) · Minimal (just the table) · With Deployment Guide (plus CI/CD and promotion)
Error Codes Standard (HTTP status codes, error format, application codes) · Simple Table · With Troubleshooting (debugging tips per error)
Rate Limits Standard (tiers, headers, retry strategy) · Overview Only · With Code Examples (retry logic in JavaScript and Python)
Webhooks Standard (events, payloads, signature verification, retries) · Event Catalog · Integration Guide (step-by-step setup and testing)
SDKs & Libraries Standard (official SDKs with install commands) · Quick Reference (install commands and repo links) · With Examples (usage examples per language)
Changelog Standard (Added/Changed/Fixed sections) · Keep a Changelog (versioned entries) · Release Notes (user-friendly, feature-focused)

Templates only pre-fill content — after creation, the page is fully editable in the rich text editor.

Organization templates

You can define custom templates that appear in the page creation dialog for all projects in your organization, listed under an Organization heading below the built-in templates.

Manage them under Settings → Doc Templates:

  1. Click Create Template (managing templates requires the org:manage-settings permission — typically Admins and Owners; everyone can view the list).
  2. Give it a Name, an optional Description, pick the page type it applies to, and write the template content in Markdown.
  3. Save. The template is immediately available in every project's New Page dialog for that page type.

Existing templates can be filtered by page type, edited in place, or deleted from the same page.