github-readme-maintenance
Installation
SKILL.md
GitHub README and Documentation Maintenance
Use this skill for edits where the goal is to keep repository-facing Markdown documentation accurate, current, and review-friendly.
Scope
Apply this skill when editing:
README.mdand similar top-level docsAGENTS.md,CLAUDE.md, and other agent-facing repository guidance- Community megathread catalogs or link indexes
- Repository runbooks, contribution guidance, and operational playbook docs
For agent-facing guidance, document stable architecture, ownership boundaries, generated-file rules, safety invariants, and executable verification commands. Do not copy temporary campaign state, process IDs, review generations, or acceptance SHAs into durable repository instructions.
Operating assumptions
- You may be working in a repository that exists in more than one local checkout.
- The expected change is usually a small, localized edit.
- The safest path is to treat target path/branch as explicit inputs.