Skip to content
Get started

Contributing

Page Template

Canonical authoring template for new Hyper docs pages.

Page Template

Section titled “Page Template”

Use this as the baseline shape for new canonical docs pages.

Frontmatter

Section titled “Frontmatter”
---
title: Example Page
description: One-sentence description of the workflow.
availability: available
roles:
  - Host
  - Participant
platforms:
  - Web
  - Mac
  - Windows
lastReviewed: 2026-03-14
visualType: text
---
Section titled “Recommended section order”
  1. Short operational introduction that explains the task and when the page matters.
  2. Optional product screenshot, clip, or screen description card.
  3. When to use this page or section.
  4. Before you start.
  5. Main workflow or capability sections.
  6. Settings, policy, or platform differences.
  7. Reference material such as role matrices or platform notes when needed.
  8. Limitations and rollout notes.
  9. Troubleshooting.
  10. Related tasks.

Intro template

Section titled “Intro template”

Use a short opening that answers the task directly:

Use this page when you need to ...


After you finish this workflow, you should be able to ...

Notes

Section titled “Notes”
  • Prefer concrete UI terms over abstract product language.
  • Use tables for role, platform, or permissions comparisons.
  • On planned pages, document the current supported path first and future capability second.