docs-platform-rollout について
docs-platform-rolloutは、プロジェクトのドキュメントを整備し、DocusaurusとVercelで公開するための自己完結型スキルです。構成、サイト設定、ローカルビルド検証を一連の手順で扱います。
主な機能
- 01ガバナンス情報を含むdocs構成の作成
- 02website/へのDocusaurusサイト設置
- 03Vercelデプロイ設定
- 04ルートのドキュメント用npmスクリプト追加
- 05ローカルサイトビルドの検証
活用シーン
- 01新規プロジェクトのドキュメント作成
- 02既存docs/ディレクトリの標準化
- 03ルートのドキュメントをVercelで公開
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ dhananjaypawar26/ docs-platform-rollout --skill docs-platform-rolloutインストール後、Claude Code で/docs-platform-rolloutを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
README.mdreferences/docs-docusaurus-vercel.SKILL.mdproject-docs-bootstrap.SKILL.mdskills-usage-and-vercel-deployment.md詳細
ドキュメントプラットフォームの導入
ユーザーがドキュメントを一度の実行ですべてセットアップしたい場合に、このスキルを使用します。
範囲
このスキルは単独で完結しており、必要な実装の詳細は references/ に含まれています。
同梱されているリファレンス:
references/project-docs-bootstrap.SKILL.mdreferences/docs-docusaurus-vercel.SKILL.mdreferences/skills-usage-and-vercel-deployment.md
リファレンスの読み込み方法
変更を加える前に、次の順序でリファレンスを読みます。
references/project-docs-bootstrap.SKILL.mdreferences/docs-docusaurus-vercel.SKILL.md- デプロイまたは再利用に関するガイダンスが必要な場合のみ、
references/skills-usage-and-vercel-deployment.md
ワークフローの順序
references/project-docs-bootstrap.SKILL.mdを使用して、docs/の構成と基本コンテンツを作成または標準化します。references/docs-docusaurus-vercel.SKILL.mdを使用して、Docusaurus でドキュメントを公開し、Vercel のデプロイを設定します。- ローカルでドキュメントのビルドを検証し、デプロイ手順を一覧表示します。
確認する入力
- プロジェクト/リポジトリ名
- ブランチ戦略(自動デプロイまたは本番環境への手動昇格)
- 希望するドキュメントのルートパス(
/docsまたは/) - Vercel のルート戦略(リポジトリのルートまたは
website)
必須の成果物
- ガバナンスメタデータを含む、本番環境対応の
docs/構成。 - ルートのドキュメントを使用する
website/の Docusaurus サイト。 - ルートディレクトリ戦略に適合した
vercel.json。 - ドキュメントの開発/ビルド/配信用のルート npm スクリプト。
- ローカルでのドキュメントビルドの検証結果。
受け入れ基準
- ドキュメント構成が存在し、内部で整合性が取れている。
npm --prefix website run buildが成功する。- サイドバーに設定済みのすべてのセクションが表示される。
- Vercel のデプロイ設定が明示的で、再現可能である。
- このスキルを単独で別のリポジトリの
.agents/skills/docs-platform-rollout/にコピーしても使用できる。
失敗時の対応
- ドキュメントのビルドに失敗した場合は、完了前に MDX/サイドバー/ルートを修正します。
- Vercel のセットアップに失敗した場合は、正確なフォールバックモード(
Mode AまたはMode B)と、ブランチ/デプロイ手順を提示します。
コメント
Markdown 対応