Authoring Kit
Use the templates in document-templates/ when creating new pages.
Use the templates in document-templates/ when creating new pages.
| Template | Use for |
|---|---|
concept.md | Explaining an idea before a task. |
how-to.md | Helping users complete one task. |
tutorial.md | Guiding a first-time end-to-end path. |
reference.md | Listing commands, settings, APIs, or fields. |
troubleshooting.md | Explaining symptoms, causes, and fixes. |
release-notes.md | Recording product changes. |
When you add a page:
- Put it in the right section folder.
- Add it to the section
meta.json. - Add a link from a related page if the reader will need it.
- Run the quality checks.
- Check Visual style before adding images or theme notes.
Fumadocs examples
Use a callout for important setup details:
<Callout type="warn">
Do not commit real secrets. Use placeholders in examples.
</Callout>Use tabs when the same task has more than one path:
<Tabs items={["Terminal", "Command Centre"]}>
<Tab>
Run `agentic team whoami`.
</Tab>
<Tab>
Open Team OS and check the signed-in user.
</Tab>
</Tabs>Use a collapsible block for optional detail:
<details>
<summary>Why this matters</summary>
The server is the source of truth for identity and permissions.
</details>Use titled code blocks for commands:
```powershell
pwsh ./scripts/check-docs.ps1
```Use images with alt text:
Use tables for permissions and settings:
| Role | Can manage clients | Can grant skills |
| --- | --- | --- |
| Owner | Yes | Yes |
| Member | No | No |