Documentation guidelines for Mastra. Use this skill when creating, editing, moving, deleting, or reviewing Mastra documentation, sidebars, redirects, or docs components.
83%
Does it follow best practices?
Run evals on this skill
Adds up to 20 points to the overall score
Passed
No findings from the security scan
Follow the most specific AGENTS.md and use these references:
references/STYLEGUIDE.md: ISO 24495-1 plain-language principles, accuracy, links, code, and accessibility.references/INFORMATION_ARCHITECTURE.md: Content families, canonical ownership, sidebars, and routes.references/DOC.md: Pages under /docs.references/GUIDE_INTEGRATION.md: Pages under /integrations.references/REFERENCE.md: Pages under /reference.references/COMPONENTS.md: Shared MDX components and llms-txt markup.references/DIAGRAM.md: Mermaid diagram shapes, colors, layout, labels, and accessibility.references/AUTHORING_WORKFLOW.md: Editing, moves, deletions, redirects, and verification.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.
When creating a page, pick the template that matches the reader's question:
| Reader question | Template | Typical location |
|---|---|---|
| "What is this area, and which option fits?" | templates/overview.md | /docs/<category>/overview |
| "What is this capability, and how do I set it up?" | templates/concept.md | /docs/<category>/<feature> |
| "How do I accomplish this specific task?" | templates/how-to.md | /docs/<category>/<task> |
| "What's the fastest way to see it working?" | templates/quickstart.md | ## Quickstart in an overview or concept page |
| "What does this API or command accept?" | templates/reference-api.md | /reference/<category>/<api-or-command> |
| "How do I use Mastra with this product?" | templates/integration.md | /integrations/<category>/<product> |
.mdx file and replace every $PLACEHOLDER.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.
mastra-ai/mastra
1072f7c
If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.