Skip to main content
Version: Next

Documentation Style Guide

Use this structure for feature pages:

  1. What it is
  2. Why it exists
  3. How to use it
  4. Common problems
  5. Related pages

Frontmatter requirements​

Every doc should include:

  • id
  • title
  • description
  • sidebar_position

Writing rules​

  • Prefer concrete steps over abstract prose.
  • Provide copy-pasteable examples.
  • State defaults and constraints explicitly.
  • Use absolute /docs/... URLs and include the version segment when needed.
  • For current docs, use /docs/next/... links.
  • For versioned docs, link within that version (for example /docs/... in version-0.1.20).

PR expectations​

Any user-visible behavior change should include matching docs updates.