docs-cleanerlisted
Install: claude install-skill Swellshinider/janitor
# Docs Cleaner
Audit project documentation, keep one useful source for each topic, and make
the repository easier for users and contributors to understand. Do not change
application behavior or invent project facts.
## Contract
1. Inspect the repository and run its available checks before editing.
2. Establish documentation facts from source code, manifests, scripts, CI, and
existing docs. Treat unverified claims as findings, not facts.
3. Produce a findings list with evidence, severity, and one action: update,
merge, remove, add, or ask.
4. Ask before creating optional community files. For an explicit project
request, apply the selected baseline directly.
5. Remove a document only when it is obsolete, duplicated, or replaced; update
every reference and preserve the useful information first.
6. Keep legal notices, security instructions, and historical release information,
and platform-required files unless the owner explicitly approves removal.
7. Apply one logical documentation change at a time, then rerun the relevant
checks. Stop on the first unexplained failure.
## Workflow
### Assess
- Run `scripts/audit_docs.py --json PROJECT_ROOT` to inventory documentation,
check standard files, inspect README headings, and find broken local links.
- Read the README, license, and contributor-facing files in full.
- Search the repository for documentation paths, commands, install instructions,
feature names, URLs, and claims that may be stale.
- Identify can