explaingit

aka-luan/doc-cleanup

Analysis updated 2026-05-18

40Audience · developerComplexity · 1/5LicenseSetup · easy

TLDR

An AI-agent skill that audits a project's markdown docs, flags outdated or contradictory facts, and rewrites them down to current, verified information.

Mindmap

mindmap
  root((doc-cleanup))
    What it does
      Audits markdown docs
      Flags stale facts
      Archives old history
    Tech stack
      SKILL.md
      Claude Code
    Use cases
      Trim required reading
      Fix contradictions
      Preserve gotchas
    Audience
      Developers
      AI agent users
    Setup
      One-line install
      Slash command trigger
      Approval before rewrite

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Audit a project's CLAUDE.md or AGENTS.md files for outdated instructions before an agent relies on them.

USE CASE 2

Shrink bloated required-reading docs by archiving finished checklists and completed plans.

USE CASE 3

Catch contradictory or stale facts in documentation after a big feature ships or a repo migration happens.

USE CASE 4

Preserve important warnings and gotchas while removing narrative history that no longer matters.

What is it built with?

MarkdownClaude CodeSKILL.md

How does it compare?

aka-luan/doc-cleanupagent0ai/doxardhaecosystem/rudr9
Stars404040
LanguageShell
Setup difficultyeasyeasymoderate
Complexity1/51/53/5
Audiencedeveloperdeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min
Use freely for any purpose, including commercial use, as long as you keep the copyright notice.

In plain English

doc-cleanup is a skill for AI coding assistants like Claude Code that finds and fixes outdated information in a project's markdown documentation, the kind of files such as CLAUDE.md or AGENTS.md that agents are told to read before writing any code. Over time these files build up finished checklists, plans that already shipped, file paths that no longer exist, and facts the codebase has since outgrown, and an agent reading them wastes both money on unnecessary context and, worse, can be led to wrong conclusions by a stale claim it never thought to double check against the real code. The README describes a real run of the skill on an existing project, where three documents totaling 1,085 lines of required reading were cut down to 266 lines, a 75 percent reduction, while nothing was actually lost, since 919 lines of history were moved into an archive folder where they remain searchable. Along the way the audit caught real problems, such as a pricing document stating the same fact two different ways in one file, a feature marked as still waiting to be merged that had actually been merged days earlier, and a rule pointing to a file path on an operating system the machine no longer used. The skill looks for six specific kinds of documentation rot: finished checklists and status logs, plans that already executed but were never rewritten, facts that contradict each other within the same document, facts that no longer match the actual code, references to files or paths that were moved or deleted, and a document being treated as authoritative long after the code moved past it. Just as deliberately, it refuses to delete hard rules, known gotchas, and warnings, since those tend to be the most valuable parts of an agent's documentation. The process runs in five steps: it inventories every markdown file, reads through and verifies claims against the actual code without changing anything, reports its findings and waits for approval, then rewrites the live documents and archives the removed history only after you say yes, and finally checks that every link still works before handing off a docs-only change for you to review. It is installed as a single skill file and can be added with a one-line command, then triggered with a slash command or by describing the task in plain language. The project is released under the MIT license.

Copy-paste prompts

Prompt 1
Run doc-cleanup on this repo and show me what it flags before making any changes.
Prompt 2
Explain the six kinds of documentation rot this skill looks for.
Prompt 3
Help me install doc-cleanup globally for all my Claude Code projects.
Prompt 4
Walk me through what happens in the diagnose and report phases before anything gets rewritten.
Prompt 5
Show me how doc-cleanup decides what to archive versus what to keep as a live warning.

Frequently asked questions

What is doc-cleanup?

An AI-agent skill that audits a project's markdown docs, flags outdated or contradictory facts, and rewrites them down to current, verified information.

What license does doc-cleanup use?

Use freely for any purpose, including commercial use, as long as you keep the copyright notice.

How hard is doc-cleanup to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is doc-cleanup for?

Mainly developer.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.