Mastra Documentation Guidelines
FreeStreamline your Mastra documentation process.
Free · Opens the source repo
What Mastra Documentation Guidelines does
The Mastra Documentation Guidelines skill is designed for developers and technical writers who are involved in creating or updating documentation for the Mastra framework. This skill provides a structured approach to ensure that all documentation is clear, consistent, and adheres to established standards. By following the guidelines, users can maintain high-quality documentation that meets the needs of its audience.
The skill includes a comprehensive set of references and style guides that cover various aspects of documentation. Users start with the general style guide and then select from specific guides based on the type of documentation they are working on, such as quickstarts, tutorials, integration guides, deployment guides, or reference materials. This targeted approach helps users create content that is not only informative but also easy to navigate and understand.
Additionally, the skill incorporates a robust linting process to maintain the quality of the documentation. By utilizing tools like oxfmt, remark, and Vale, users can ensure their documentation is well-formatted, free of grammatical errors, and consistent in style. The skill provides clear commands for formatting and linting documentation, making it easy to integrate these practices into the documentation workflow.
Overall, the Mastra Documentation Guidelines skill is an essential tool for anyone involved in documentation for Mastra, providing the necessary resources and processes to create professional-grade documentation efficiently.
When to use it
Use this skill when creating or updating any documentation related to Mastra to ensure clarity and adherence to guidelines.
When not to use it
This skill may not be suitable for projects outside of Mastra or for documentation that does not require strict adherence to these specific guidelines.
What you can build with it
Creating a Quickstart Guide
Use this skill to draft a quickstart guide that helps users get started with a specific Mastra library or framework.
Updating Existing Documentation
Leverage the guidelines to update and improve clarity and consistency in existing Mastra documentation.
Integrating with External Libraries
Follow the integration guide to document how Mastra works with external libraries or ecosystems.
How to install Mastra Documentation Guidelines
View source1. Install with the skills CLI
npx skills add mastra-ai/mastra/mastra-docs --agent claude-code2. Or install it manually
Download the skill folder and drop it into ~/.claude/skills/ for all projects, or .claude/skills/ to scope it to one repo. Restart Claude Code so it picks up the new skill.
Anthropic's agentic coding CLI, and the reference implementation of Agent Skills. Drop a skill folder into ~/.claude/skills and Claude Code loads it automatically whenever a task matches the skill's description. Claude Code docs
Inside SKILL.md
Written by mastra-aiMastra Documentation Guidelines
Use this skill when you create or update Mastra docs. Keep the docs clear and consistent. Follow the most specific AGENTS.md for the area you change. After making your changes to the docs and sidebars, run the linters to check your work.
Styleguides
Start with references/STYLEGUIDE.md for all docs. Then use the guide that matches the content:
- references/DOC.md: General docs that do not fit the categories below
- Choose the right guide for the file's content:
- references/GUIDE_QUICKSTART.md: Quickstarts that help readers get working fast with a specific library or framework
- references/GUIDE_TUTORIAL.md: Tutorials that teach readers how to build something with Mastra
- references/GUIDE_INTEGRATION.md: Integration guides for using Mastra with an external library or ecosystem
- references/GUIDE_DEPLOYMENT.md: Deployment guides for shipping a Mastra app to a platform
- references/REFERENCE.md: Reference and API docs
Linting
Use these tools to keep docs consistent:
- oxfmt: Formats docs code, Markdown, config, and style files through the docs-local config.
- oxfmt-mdx: Formats MDX through the docs-local custom parser so admonitions, JSX expressions, and fenced code blocks remain supported.
- remark: Checks markdown issues like heading levels, list styles, and formatting consistency. This is the middle layer.
- vale: Checks grammar, style, and wording. This is the top layer.
- In order to use Vale, you must download the Vale binary and install
mdx2vastglobally.pnpm run vale:download,npm install -g mdx2vast.
- In order to use Vale, you must download the Vale binary and install
Run these commands in docs/:
- pnpm run format: Format docs files with oxfmt and docs-local oxfmt-mdx
- pnpm run format:check: Check docs formatting with oxfmt and docs-local oxfmt-mdx
- pnpm run lint:remark: Check MDX with Remark
- pnpm run lint:vale:ai: Check prose with Vale using the error alert level
- pnpm run validate: Check frontmatter values and if all sidebars are valid
- pnpm run generate-vercel-redirects: Generate vercel.json redirects after editing vercel.redirects.json
Frequently asked questions about Mastra Documentation Guidelines
Similar skills
Supabase Docs Authoring
Streamline your Supabase documentation process.
Docs Writer
Streamline your documentation process with precision.
Clinical Case Report
Generate structured medical case presentations.
CrossFrame Suite
Streamline complex workflows for Chinese structural analysis.
Em Dash Expert
Master the em dash for clear, precise writing.
Nature Statistics Reporting
Enhance manuscript statistics for high-impact journal submissions.