About mastra-docs
A documentation-authoring skill for contributors working on Mastra docs. It directs writers to shared standards and page-specific guides for structure, components, diagrams, and editing workflows.
Key features
- 01References for style and information architecture
- 02Guides for docs, integrations, and reference pages
- 03Instructions for shared MDX components
- 04Mermaid diagram conventions
- 05Editing, redirects, and verification guidance
Use cases
- 01Drafting or revising Mastra documentation
- 02Choosing the canonical location and route for content
- 03Creating or updating documentation diagrams
Install
Copy the command and run it in a terminal.
$
npx skills add https:/After installing, type/mastra-docsin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
references/AUTHORING_WORKFLOW.mdCOMPONENTS.mdDIAGRAM.mdDOC.mdGUIDE_INTEGRATION.mdINFORMATION_ARCHITECTURE.mdREFERENCE.mdSTYLEGUIDE.mdDetails
From the project READMEMastra documentation guidelines
Follow the most specific AGENTS.md and use these references:
references/STYLEGUIDE.md: Global writing, accuracy, links, code, and accessibility rules.references/INFORMATION_ARCHITECTURE.md: Content families, canonical ownership, sidebars, and routes.- Choose the page guide:
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.
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.
Comments
Markdown supported