Stats
Actions
Tags
Help us improve
Share bugs, ideas, or general feedback.
From claude-swe-workflows
Spawns a doc-maintainer agent to audit all project documentation for correctness, completeness, freshness, and consistency. It autonomously fixes issues like typos, stale code examples, and broken links, surfacing anything requiring user approval.
npx claudepluginhub chrisallenlane/claude-swe-workflows --plugin claude-swe-workflowsHow this skill is triggered — by the user, by Claude, or both
Slash command
/claude-swe-workflows:tidy-docsopusThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Spawns a `doc-maintainer` agent to comprehensively audit all project documentation and fix the issues it finds. The find→fix seam is small — typos, stale code examples, broken links, freshness drift — so the skill runs as a tidy rather than a review.
Audits codebase documentation for accuracy, completeness, and freshness by comparing against code structure. Auto-fixes small discrepancies in fix mode, reports structural changes. Works with any language/framework.
Audits documentation staleness via git history and maintains quality with auto-fixes. Maps code paths to docs in $JAAN_DOCS_DIR. Use for reviewing or updating docs.
Detects documentation drift, stale references, and cross-document inconsistencies in projects. Scans code-doc mismatches, broken links, outdated versions, and git staleness.
Share bugs, ideas, or general feedback.
Spawns a doc-maintainer agent to comprehensively audit all project documentation and fix the issues it finds. The find→fix seam is small — typos, stale code examples, broken links, freshness drift — so the skill runs as a tidy rather than a review.
Spawn a DOC - Maintainer agent with the following prompt:
Perform a comprehensive review of ALL project documentation. This is a
standalone audit — do NOT scope to git diff. Instead, review every
documentation file in the project.
Steps:
1. Discover all documentation files (README.md, CLAUDE.md, CONTRIBUTING.md,
CHANGELOG.md, doc/, docs/, adr/, and any other .md files)
2. Review each for correctness, completeness, and freshness using your
full quality checklist (code-documentation consistency, completeness,
link validation, style consistency, freshness)
3. Fix issues you find autonomously (within your authority)
4. Report what you changed and any issues requiring user approval
If no documentation issues are found, report that and exit.
After the agent completes, present its findings to the user:
If changes were made, ask the user if they want to commit. If yes:
git add [specific files]
git commit -m "$(cat <<'EOF'
docs: tidy project documentation
[Brief description of changes made]
EOF
)"