Mastra Docs

Documentation guidelines for Mastra. Use this skill when creating, editing, moving, deleting, or reviewing Mastra documentation, sidebars, redirects, or docs components.

mastra-ai c1960cb 1.2 KB Updated

File contents

Mastra documentation guidelines

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

  1. references/STYLEGUIDE.md: Global writing, accuracy, links, code, and accessibility rules.
  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.

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

Treat page patterns as guidance rather than fixed templates. Match the reader's task and the conventions of the current section.

mastra-ai/mastra commit c1960cbe76

Frequently asked questions

npx skillmds@latest add mastra-ai/mastra-docs