check-docs

ドキュメントのリンク切れとフォーマットの問題をチェック

Check Docs

ドキュメントファイルをスキャンして一般的な問題を検出し、見つかった問題を報告します。

使用するタイミング

• ドキュメントの変更を公開またはマージする前
• リンク切れを検出するためのレビューワークフローの一環として
• ドキュメント構造を再編成した際にリンクが壊れていないか確認する時

動作の仕組み

1. 設定されたdocsDir内のすべての.mdxおよび.mdファイルをスキャン
2. 内部リンク切れ（存在しないページへの参照）をチェック
3. フロントマターフィールドの欠落（titleは必須）をチェック
4. 結果をサマリーとして報告

使用例

/check-docs

実行されるチェック

• リンク切れ — 存在しないファイルを指す内部[テキスト](./パス)リンク
• タイトルの欠落 — フロントマターにtitleがないMDXファイル
• 空のファイル — フロントマター後にコンテンツがないファイル
• sidebar_positionの重複 — 同じカテゴリ内で同じposition値を持つ複数のファイル