mcpField
M
mastra-docs

mastra-docs

github.com/mastra-aiドキュメント29.2k158 回インストール今日更新
リポジトリ

mastra-docs について

Mastra ドキュメントのコントリビューター向け執筆ガイドです。ページ種別に応じた共通規則や個別資料を案内し、構成、コンポーネント、図、編集手順を扱います。

主な機能

  1. 01スタイルと情報アーキテクチャの参照資料
  2. 02docs、integrations、reference ページのガイド
  3. 03共有 MDX コンポーネントの説明
  4. 04Mermaid 図の規則
  5. 05編集、リダイレクト、検証の手順

活用シーン

  1. 01Mastra ドキュメントの執筆や改訂
  2. 02コンテンツの正規の配置場所とルートの選定
  3. 03ドキュメント図の作成や更新

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/mastra-ai/mastra --skill mastra-docs

インストール後、Claude Code で/mastra-docsを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
AUTHORING_WORKFLOW.md
COMPONENTS.md
DIAGRAM.md
DOC.md
GUIDE_INTEGRATION.md
INFORMATION_ARCHITECTURE.md
REFERENCE.md
STYLEGUIDE.md

詳細

Mastra ドキュメントのガイドライン

最も具体的な AGENTS.md に従い、次のリファレンスを使用してください。

  1. references/STYLEGUIDE.md:全体的な執筆、正確性、リンク、コード、アクセシビリティに関するルール。
  2. references/INFORMATION_ARCHITECTURE.md:コンテンツの分類、正規の管理元、サイドバー、ルート。
  3. ページに対応するガイドを選択します。
    • /docs 配下のページ:references/DOC.md。
    • /integrations 配下のページ:references/GUIDE_INTEGRATION.md。
    • /reference 配下のページ:references/REFERENCE.md。
  4. references/COMPONENTS.md:共通の MDX コンポーネントと llms-txt のマークアップ。
  5. references/DIAGRAM.md:Mermaid 図の形状、色、レイアウト、ラベル、アクセシビリティ。
  6. references/AUTHORING_WORKFLOW.md:編集、移動、削除、リダイレクト、検証。

既存の図の画像を Mermaid に置き換える場合は、docs-diagrams スキルを使用してください。

ページのパターンは固定テンプレートではなく、ガイドとして扱ってください。読者の目的と、現在のセクションの慣例に合わせてください。

コメント