Revise README Markdown
Incremental and lightweight updater for README.md after adding new documentation files or modifying features.
1. Fast Preflight
- Identify newly added or modified markdown files in current task/commit.
- Filter out internal files (
docs/superpowers/,.git/,.claude/,.gemini/). - If no human markdown docs were added/modified, check if project summary requires adjustment.
2. Diátaxis Classification & Index Hunk Update
- Classify new/modified files into Diátaxis quadrants (Tutorials, How-To, Reference, Explanation).
- Generate targeted hunk diff for
README.md(ordocs/okf/README.mdif the file is an OKF doc). - Re-verify project summary character count (must remain between 100 and 500 characters).
3. Approval & Apply
- Present minimal diff for
README.md. - Wait for explicit user approval.
- Apply surgical change without modifying unrelated sections.
Safety
- Do not rewrite the entire
README.md. - Preserve existing badges, quick start, license, and custom sections.
- Exclude
docs/superpowers/from indexing.