mastra-docs について
Mastra ドキュメントのコントリビューター向け執筆ガイドです。ページ種別に応じた共通規則や個別資料を案内し、構成、コンポーネント、図、編集手順を扱います。
主な機能
- 01スタイルと情報アーキテクチャの参照資料
- 02docs、integrations、reference ページのガイド
- 03共有 MDX コンポーネントの説明
- 04Mermaid 図の規則
- 05編集、リダイレクト、検証の手順
活用シーン
- 01Mastra ドキュメントの執筆や改訂
- 02コンテンツの正規の配置場所とルートの選定
- 03ドキュメント図の作成や更新
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ mastra-ai/ mastra --skill mastra-docsインストール後、Claude Code で/mastra-docsを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
references/AUTHORING_WORKFLOW.mdCOMPONENTS.mdDIAGRAM.mdDOC.mdGUIDE_INTEGRATION.mdINFORMATION_ARCHITECTURE.mdREFERENCE.mdSTYLEGUIDE.md詳細
Mastra ドキュメントのガイドライン
最も具体的な AGENTS.md に従い、次のリファレンスを使用してください。
references/STYLEGUIDE.md:全体的な執筆、正確性、リンク、コード、アクセシビリティに関するルール。references/INFORMATION_ARCHITECTURE.md:コンテンツの分類、正規の管理元、サイドバー、ルート。- ページに対応するガイドを選択します。
/docs配下のページ:references/DOC.md。/integrations配下のページ:references/GUIDE_INTEGRATION.md。/reference配下のページ:references/REFERENCE.md。
references/COMPONENTS.md:共通の MDX コンポーネントと llms-txt のマークアップ。references/DIAGRAM.md:Mermaid 図の形状、色、レイアウト、ラベル、アクセシビリティ。references/AUTHORING_WORKFLOW.md:編集、移動、削除、リダイレクト、検証。
既存の図の画像を Mermaid に置き換える場合は、docs-diagrams スキルを使用してください。
ページのパターンは固定テンプレートではなく、ガイドとして扱ってください。読者の目的と、現在のセクションの慣例に合わせてください。
コメント
Markdown 対応