check-docs
Verify documentation quality - checks README.md, CLAUDE.md, and other docs for completeness and accuracy
Installation
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
View source ↗GuidesSkill instructions
Check Docs Skill
Verify that project documentation is complete, accurate, and up-to-date.
Usage
/check-docs # Check docs in current directory
/check-docs ./path # Check docs in specific path
What Gets Checked
| File | Checks |
|---|---|
| README.md | Exists, non-empty, links valid, install steps current |
| CLAUDE.md | Exists (if Claude project), paths valid, commands work |
| Other .md | Exist if referenced, links valid |
Output
Checklist format showing pass/fail for each check with details on issues found.
Runbook
Full procedure: runbook/check-docs.md in your knowledge base.
Examples
Read the usage examples in the source repository.
View source ↗Source history
- Indexed on
- 2026-01-20
- Index updated
- 2026-02-04
- Branch
- main
Index and sync dates describe this directory. View the source repository for code history.
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!