mastra-docs

Mastra documentation guidelines

Follow the most specific AGENTS.md and use these references:

1. references/STYLEGUIDE.md: ISO 24495-1 plain-language principles, accuracy, links, code, and accessibility.
2. references/INFORMATION_ARCHITECTURE.md: Content families, canonical ownership, sidebars, and routes.
3. Choose the page guide:
   • references/DOC.md: Pages under /docs.
   • references/GUIDE_INTEGRATION.md: Pages under /integrations.
   • references/REFERENCE.md: Pages under /reference.
4. references/COMPONENTS.md: Shared MDX components and llms-txt markup.
5. references/DIAGRAM.md: Mermaid diagram shapes, colors, layout, labels, and accessibility.
6. references/AUTHORING_WORKFLOW.md: Editing, moves, deletions, redirects, and verification.
7. references/CHECKS.md: The pnpm check command, rule IDs, JSON output, and inline lint comments for disabling rules.

To replace an existing diagram image with Mermaid, use the docs-diagrams skill.

Page templates

When creating a page, pick the template that matches the reader's question:

1. Copy the template's skeleton into the new .mdx file and replace every $PLACEHOLDER.
2. Compare the result with the template's example page and with neighboring pages. Where the section has an established convention, follow it.
3. Remove optional sections the page doesn't need.
4. Before finishing, run templates/CHECKLIST.md and the template's own self-review checklist.

Templates set the starting shape, not a fixed form. Match the reader's task and the conventions of the current section.