Skip to main content

Summary

Use these templates when adding or reshaping docs pages so the site stays structurally consistent without forcing every page into the exact same mold.

Who this is for

Internal contributors maintaining the docs site and content standards.

Setup guide template

  • Summary
  • Who this is for
  • Where to find it
  • Requirements or prerequisites
  • Recommended order of operations
  • Success checklist
  • Related pages

Workflow page template

  • Summary
  • Who this is for
  • Where to find it
  • Typical workflow or operating model
  • What the current app suggests
  • Success checklist
  • Related pages

Concept page template

  • Summary
  • Who this is for
  • The key distinction or core idea
  • What the current product suggests
  • Common misunderstandings to avoid
  • Related pages

Reference page template

  • Summary
  • Fast lookup table, map, or checklist
  • Short clarification notes
  • Related pages

Honest placeholder template

Use only when a section must exist before the full docs are ready.
  • say clearly that the section is future-facing
  • describe what will eventually live there
  • describe what the page does not claim today
  • link readers back to currently supported docs