mastra-docs

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Mastra Documentation Guidelines

Mastra 文档编写指南

Instructions and styleguides for writing and maintaining Mastra documentation. This skill should be used whenever creating or updating documentation for Mastra to ensure consistency, clarity, and quality across all docs.

本文档包含Mastra文档的编写与维护说明及风格指南。创建或更新Mastra文档时均应遵循本规范，以确保所有文档的一致性、清晰性和质量。

Scope

适用范围

```
@docs/
```
- This folder contains the source code and contents of the documentation site. All documentation for Mastra should be created and maintained here.
```
@docs/src/content/en/
```
- This subfolder contains the actual markdown files for the documentation site, organized into
```
docs/
```
,
```
guides/
```
, and
```
reference/
```
sections. The
```
models/
```
subfolder contains auto-generated documentation for model providers and should not be edited manually.

```
@docs/
```
- 该文件夹包含文档站点的源代码和内容。所有Mastra文档均应在此创建和维护。
```
@docs/src/content/en/
```
- 此子文件夹包含文档站点的实际Markdown文件，分为
```
docs/
```
、
```
guides/
```
和
```
reference/
```
三个部分。
```
models/
```
子文件夹包含模型提供商的自动生成文档，请勿手动编辑。

Styleguides

风格指南

Follow the general styleguide at

@docs/styleguides/STYLEGUIDE.md

for all documentation. Additionally, refer to these specific styleguides when writing different types of documentation:

@docs/styleguides/DOC.md

- For any file inside

@docs/src/content/en/docs/

For any file inside
```
@docs/src/content/en/guides/
```
choose the correct styleguide based on content:
- ```
@docs/styleguides/GUIDE_QUICKSTART.md
```
  - For quickstart guides that get the reader to a working result as fast as possible with a specific library/framework.
- ```
@docs/styleguides/GUIDE_TUTORIAL.md
```
  - For tutorial guides that teach the reader how to build something specific with Mastra, going deeper into concepts.
- ```
@docs/styleguides/GUIDE_INTEGRATION.md
```
  - For integration guides that provide a comprehensive reference for using Mastra with a specific external library or ecosystem.
- ```
@docs/styleguides/GUIDE_DEPLOYMENT.md
```
  - For deployment guides that walk the reader through deploying their Mastra application to a specific platform.

@docs/styleguides/REFERENCE.md

- For any file inside

@docs/src/content/en/reference/

所有文档均需遵循

@docs/styleguides/STYLEGUIDE.md

中的通用风格指南。此外，编写不同类型的文档时，请参考以下特定风格指南：

@docs/styleguides/DOC.md

- 适用于

@docs/src/content/en/docs/

目录下的所有文件

对于
```
@docs/src/content/en/guides/
```
目录下的文件，请根据内容选择正确的风格指南：
- ```
@docs/styleguides/GUIDE_QUICKSTART.md
```
  - 适用于快速入门指南，旨在帮助读者尽快使用特定库/框架实现可用成果。
- ```
@docs/styleguides/GUIDE_TUTORIAL.md
```
  - 适用于教程指南，教授读者如何使用Mastra构建特定项目，并深入讲解相关概念。
- ```
@docs/styleguides/GUIDE_INTEGRATION.md
```
  - 适用于集成指南，为Mastra与特定外部库或生态系统的结合使用提供全面参考。
- ```
@docs/styleguides/GUIDE_DEPLOYMENT.md
```
  - 适用于部署指南，引导读者将其Mastra应用部署到特定平台。

@docs/styleguides/REFERENCE.md

- 适用于

@docs/src/content/en/reference/

目录下的所有文件