readme-agents-doc

Generates and idempotently updates high-quality README.md and AGENTS.md files for any repository. Runs a fixed step-by-step pipeline — a 4-phase recon pass (manifests → architecture → conventions → artifacts), a Purpose & Gotchas discovery phase, optional PR intelligence via gh, then heading-anchored template rendering for safe re-runs — stopping to ask the user at defined decision gates. Optionally leverages RTK for token compression, ast-grep for AST-aware code exploration, and gh for merged-PR context. Nests writing-clearly-and-concisely for prose quality.

Use when writing prose humans will read—documentation, commit messages, error messages, explanations, reports, or UI text. Applies Strunk's timeless rules for clearer, stronger, more professional writing.