StaleDocs

StaleDocs

以前は aidoc という名称でした。

StaleDocs はコードを読み取り、プルリクエスト内のパブリック API の変更を見つけ、どのドキュメントのセクションが古い動作を記載したままになっているかを知らせます。

ウェブサイト · GitHub Action のセットアップ

1 つのファイルでリポジトリに追加

name: StaleDocs review
on: {pull_request: {types: [opened, synchronize, reopened]}}
permissions: {contents: read, pull-requests: write}
jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
        with: {fetch-depth: 0}
      - uses: mr-min-max/[email protected]
        with:
          mode: review
          fail-on: none

コメントの内容

• 変更されたシンボルと、変更前後のシグネチャ。
• それらに言及しているものの、更新されていないセクション。
• 該当する場合は breaking-change および docs-stale ラベル。

モデルも API キーも書き込みも不要です。決定論的な AST 解析を行います。

ターミナルから使用する

コマンドをインストールします。

npm install -g staledocs@beta

staledocs review はプルリクエストによるドキュメントへの影響を報告します。

staledocs plan は影響を受けるドキュメントの対象を出力します。

staledocs check は、変更されたパブリックシンボルに言及するセクションが更新されていない場合は終了コード 1 を返し、それ以外の場合は 0 を返します。

リポジトリを一度監査する

staledocs audit は、Markdown で言及されているものの、コードにはもう存在しないパッケージスクリプト、リポジトリのパス、パブリッククラスメンバーを一覧表示します。対象には、コーディングエージェントが最初に読み取る AGENTS.md、CLAUDE.md、および .github 内の copilot-instructions.md ファイルも含まれます。プルリクエストは不要です。このコマンドは 0.5.0-beta.1 で追加されました。

npm install -g staledocs@beta
staledocs audit

小規模なフィクスチャリポジトリでの出力：

README.md > Usage: member-missing "Client.fetchAll"
README.md > Usage: path-missing "src/core/old.ts"
README.md > Usage: script-missing "npm run bulid" (closest: build)

3 findings across 1 Markdown file: script-missing 1, path-missing 1, member-missing 1.

アシスタントを使ってドキュメントを修正する

Claude Code プラグイン

Git のワークツリーで Claude Code を起動し、次を実行します。

/plugin marketplace add mr-min-max/staledocs
/plugin install staledocs@staledocs

ドリフトの兆候を確認するには /staledocs:check、PR レポートには /staledocs:review、検証済みのドラフトには /staledocs:maintain-documentation を使用します。Node.js >=22.12.0 と npm/npx が必要です。このリポジトリは独自のプラグインマーケットプレイスをホストしています。Anthropic の承認済みディレクトリには掲載されていません。

Codex プラグイン

Git のワークツリーで Codex を起動し、次を実行します。

codex plugin marketplace add mr-min-max/staledocs
codex plugin add staledocs@staledocs

新しいセッションで $ を入力し、staledocs:check、staledocs:review、staledocs:maintain-documentation のいずれかを選択します（または /skills を開きます）。Node.js >=22.12.0 と npm/npx が必要です。このリポジトリは独自のプラグインマーケットプレイスをホストしています。OpenAI のプラグインディレクトリには掲載されていません。

手動での MCP

codex mcp add staledocs -- staledocs --mcp

prepare_documentation_update は、該当するセクションと変更前後のシグネチャを正確にアシスタントに渡します。

StaleDocs が候補を検証し、アシスタントが承認済みの Markdown を適用します。

Codex ガイドとClaude ガイドをご覧ください。

言語

TypeScript、JavaScript、Python に対応しています。パブリックシンボルとは、パッケージのエントリから到達可能なシンボルです。詳しくは LIMITATIONS.md をご覧ください。

構文と検出に関する注意事項については、LIMITATIONS.md をご覧ください。

レガシーのジェネレーター

readme、api、changelog、diagram、annotate は、初期ドキュメントの作成用として引き続き利用できます。これらにはプロバイダーキーまたは Ollama が必要で、StaleDocs の主な対象ではありません。CLI カタログをご覧ください。

ステータスとリンク

リリース候補 0.5.0-beta.1 はまだ公開されていません。公開されるまでは、npm の latest、npm の beta、および GitHub Action の v0 タグは、以前に公開されたベータ版を指したままです。また、上記およびプラグイン内の v0.5.0-beta.1 の固定バージョンは、公開後にのみ解決されます。

• コントリビューション
• セキュリティ
• 制限事項
• 変更履歴
• GitHub Action マーケットプレイス
• 評価