Finds documentation that no longer matches your code. Deterministic AST check for pull requests; no API key. TypeScript, JavaScript, Python.
See the codeFormerly aidoc.
StaleDocs reads your code, finds public API changes in a pull request, and tells you which documentation sections now describe the old behavior.
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/staledocs@v0.4.0-beta.1
with:
mode: review
fail-on: none
breaking-change and docs-stale labels when applicable.No model, no API key, no writes. It is deterministic AST analysis.
Install the command:
npm install -g staledocs@beta
staledocs review reports documentation impact for a pull request.
staledocs plan prints the affected documentation targets.
staledocs check exits with code 1 when a section mentioning a changed public symbol was not updated, and exits 0 otherwise.
Start Claude Code in your Git worktree, then run:
/plugin marketplace add mr-min-max/staledocs
/plugin install staledocs@staledocs
Use /staledocs:check for drift signals, /staledocs:review for the PR report,
or /staledocs:maintain-documentation for a validated draft. Requires Node.js
=22.12.0 and npm/npx. This repository hosts its own plugin marketplace; it is not an approved Anthropic directory listing.
codex mcp add staledocs -- staledocs --mcp
prepare_documentation_update gives the assistant the exact sections and before and after signatures.
StaleDocs validates the candidate, and the assistant applies the approved Markdown.
See the Codex guide and Claude guide.
TypeScript, JavaScript, and Python are supported. A public symbol is one reachable from the package entry; see LIMITATIONS.md.
See LIMITATIONS.md for syntax and discovery caveats.
readme, api, changelog, diagram, and annotate remain available for initial documentation. They need a provider key or Ollama and are not the focus of StaleDocs. See the CLI catalogue.
StaleDocs 0.4.0-beta.1 is published. npm latest, npm beta, and the GitHub Action v0 tag all use this release.
Finds documentation that no longer matches your code. Deterministic AST check for pull requests; no API key. TypeScript, JavaScript, Python.
See the codeFormerly aidoc.
StaleDocs reads your code, finds public API changes in a pull request, and tells you which documentation sections now describe the old behavior.
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/staledocs@v0.4.0-beta.1
with:
mode: review
fail-on: none
breaking-change and docs-stale labels when applicable.No model, no API key, no writes. It is deterministic AST analysis.
Install the command:
npm install -g staledocs@beta
staledocs review reports documentation impact for a pull request.
staledocs plan prints the affected documentation targets.
staledocs check exits with code 1 when a section mentioning a changed public symbol was not updated, and exits 0 otherwise.
Start Claude Code in your Git worktree, then run:
/plugin marketplace add mr-min-max/staledocs
/plugin install staledocs@staledocs
Use /staledocs:check for drift signals, /staledocs:review for the PR report,
or /staledocs:maintain-documentation for a validated draft. Requires Node.js
=22.12.0 and npm/npx. This repository hosts its own plugin marketplace; it is not an approved Anthropic directory listing.
codex mcp add staledocs -- staledocs --mcp
prepare_documentation_update gives the assistant the exact sections and before and after signatures.
StaleDocs validates the candidate, and the assistant applies the approved Markdown.
See the Codex guide and Claude guide.
TypeScript, JavaScript, and Python are supported. A public symbol is one reachable from the package entry; see LIMITATIONS.md.
See LIMITATIONS.md for syntax and discovery caveats.
readme, api, changelog, diagram, and annotate remain available for initial documentation. They need a provider key or Ollama and are not the focus of StaleDocs. See the CLI catalogue.
StaleDocs 0.4.0-beta.1 is published. npm latest, npm beta, and the GitHub Action v0 tag all use this release.