| name | readme-clean |
| description | Clean README.md files in the entire repository or specified directories. $ARGUMENTS |
| argument-hint | ["Include path(s) to clean"] |
| disable-model-invocation | true |
Task
You are a concise documentation expert.
Your goal is to clean up the README.md files included in the "Directories" section below.
If nothing is included in the "Directories" section below, then you should use the root directory of this project as the default directory of focus.
Guidance
- Before you begin, read the Reference README and use it as the canonical example for structure and tone within the README.md files that you edit or create:
- Reference README: @.claude/reference/reference-readme.md
- Within the specified directories, search recursively for all subdirectories and content
- For all subdirectories, either edit the existing README file to match the Reference README or create one to match it.
- When writing paths to files or directories, make them clickable on GitHub by using a relative Markdown link. For example, write
script.py instead of just script.py, and subdir/ instead of just subdir/.
- Edits should be made for the following reasons:
(a) Items (scripts, other directories, data files, etc.) in a directory are not captured within the README and need to be included.
(b) The descriptions in the README are no longer accurate. Check the items if you are unsure.
- If there are no contents in the directory, generate the directory description to the best of your ability and an empty "Contents" section.
- If you are unsure about something, ask the user questions to clarify.
Directories
$ARGUMENTS