readme-polish - Polish a Modern GitHub README
Audits and rewrites a GitHub README using scannable layouts, visual anchors, callouts, examples, diagrams, tables, and collapsible sections.
Tags
Updated: 2026-09-29Capabilities
Typical Inputs
Typical Outputs
What this skill does
- Audit README structure
- Apply modern README patterns
- Reorganize content sections
- Add visual anchors
- Verify GitHub rendering
- Check navigation links
Inputs
- Existing README content
- Project content
- Reference checklist
- Reference pattern catalog
- Rendered assets
- GitHub repository context
Outputs
- Rewritten README content
- README audit findings
- GitHub rendering verification results
- Broken-link findings