doc-cleanup

doc-cleanup is a command for Claude Code from zircote-plugins/documentation-review. It costs 11 tokens per session (870 once invoked), scanned A, original, MIT.

A documentation review command that finds obsolete, duplicated, orphaned, and broken documentation by comparing documents with the codebase. Orphaned documentation is a file that is not linked or included in the project's navigation.

In plain words
What is it for?
Use it to identify documentation needing human review, including stale version references, dead links, missing images, and content copied in multiple places. It reports findings without deleting files.
Why use it?
It helps reveal instructions that describe deleted features, old paths, deprecated commands, or missing files before someone relies on them.

Command for Claude Code

Written for Claude Code: allowed-tools in frontmatter.

Needs its repository: it runs a file that does not travel with it, so clone the repository first. The line is | README.md | ./docs/old-guide.md | Internal |.

Part of the documentation-review plugin — 4 skills, 6 commands, 2 agents shipped together

Good fit Use it to identify documentation needing human review, including stale version references, dead links, missing images, and content copied in multiple places. It reports findings without deleting files.

Compare 6 commands from other repositories ↓
Install

Getting it into your agent

It runs from inside its repository, so the clone comes first — what it calls does not travel with the file alone.

Clone the repo
git clone --depth 1 https://github.com/zircote-plugins/documentation-review
agentmods
npx agentmods add commands/zircote-plugins/documentation-review/doc-cleanup

Made for: Claude Code.

Or install documentation-review, the plugin that ships this one along with the rest of its 4 skills, 6 commands, 2 agents.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for doc-cleanup

README.md
[![agentmods](https://agentmods.dev/badge/commands/zircote-plugins/documentation-review/doc-cleanup/github.svg)](https://agentmods.dev/commands/zircote-plugins/documentation-review/doc-cleanup)
Your own site
<a href="https://agentmods.dev/commands/zircote-plugins/documentation-review/doc-cleanup"><img src="https://agentmods.dev/badge/commands/zircote-plugins/documentation-review/doc-cleanup/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for doc-cleanup

Your own site · 80×15
<a href="https://agentmods.dev/commands/zircote-plugins/documentation-review/doc-cleanup"><img src="https://agentmods.dev/badge/commands/zircote-plugins/documentation-review/doc-cleanup.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 11 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 870 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00011 $0.00870
Opus 5.5 $0.00004 $0.00348
Sonnet 5.5 $0.00002 $0.00174
Haiku 4.5 $0.00001 $0.00087

Measured 1mo ago against content hash 5ab2fb939e04, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

doc-cleanup scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 1mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

commands/doc-cleanup.md · 143 lines

How it starts

The opening of the file, as written. The whole thing — 143 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Identify obsolete documentation for user review. This command reports only - it does not delete files.

Cleanup Analysis

1. Find Documentation Files

Use Glob to locate all documentation:

  • docs/**/*.md
  • *.md (root level)
  • **/*.rst (if RST supported)

2. Detect Obsolete Content

Orphaned Documentation

  • Files not linked from any other document
  • Files not in navigation/sidebar config
  • README files in deleted directories

Stale Content Indicators

  • Last modified date > 1 year ago
  • References to deleted files/directories
  • Mentions deprecated APIs or features
  • Version numbers significantly behind current

Duplicate Content

  • Similar content across multiple files
  • Copied sections that may be out of sync
  • Redundant documentation of same feature

Dead References

  • Internal links to non-existent files
  • Anchor links to removed sections
  • Image references to missing assets

3. Check Against Codebase

Removed Features

  • Documentation for deleted code
  • APIs that no longer exist
  • Configuration options removed
  • CLI commands deprecated

Renamed Components

  • Old names still in documentation
  • Outdated file paths
  • Changed package/module names

4. Analyze Git History

Check for:

  • Files unchanged for long periods
  • Files with many authors (may indicate confusion)
  • Files deleted and restored (uncertain status)

Report Format

# Documentation Cleanup Report

**Generated:** [date]
**Files Analyzed:** [count]
**Issues Found:** [count]

## Obsolete Documentation

### High Confidence (Safe to Remove)

| File | Reason | Last Modified |
|------|--------|---------------|
| docs/old-api.md | API deleted in v2.0 | 2023-01-15 |
| docs/legacy-setup.md | Feature deprecated | 2022-06-20 |

### Medium Confidence (Review Recommended)

| File | Reason | Notes |
|------|--------|-------|
| docs/advanced-config.md | No internal links | May be standalone guide |
| README-old.md | Possibly backup | Check if needed |

### Low Confidence (Needs Investigation)

| File | Observation |
|------|-------------|
| docs/troubleshooting.md | Not updated in 18 months |

## Duplicate Content

| Primary | Duplicate | Similarity |
|---------|-----------|------------|
| docs/setup.md | docs/getting-started.md | 85% |

## Broken References

| File | Broken Link | Type |
|------|-------------|------|
| README.md | ./docs/old-guide.md | Internal |
| docs/api.md | #deprecated-section | Anchor |

## Diátaxis Gap Analysis (enabled by default; disable with `diataxis.enabled: false`)

| Feature/Component | Tutorial | How-to | Reference | Explanation |
|-------------------|----------|--------|-----------|-------------|
| [feature]         | Yes      | -      | Yes       | -           |

### Priority Gaps
1. [Feature]: Missing [quadrant] — [user impact]

## Recommended Actions

1. **Remove** (high confidence): [list of files]
2. **Consolidate**: [duplicates to merge]
3. **Update**: [files with broken references]
4. **Investigate**: [uncertain files]
5. **Create** (Diátaxis gaps): [missing quadrant documents to create]

## Important Notes

- This report is advisory only
- No files have been modified
- Review each item before taking action
- Consider archiving instead of deleting

Read the full file on GitHub · 143 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 1mo ago First seen · 143 lines · 11 tokens per session scan A 5ab2fb939e04

Subscribe to this mod's changes

doc-cleanup is a command published in the GitHub repository zircote-plugins/documentation-review (5 stars, last pushed 3mo ago), licensed MIT. It adds 11 tokens to every session and 870 once invoked, about $0.0000 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.