draft-repo-readme

Generate a README by reading the repository's manifest files, commit history, and top-level files to draft an honest overview grounded in the repo's actual content. The output is stored in the _drafts/<repo>/README.md directory.

Avoid hallucinated details in repo documentation by grounding the draft in verifiable provenance from manifests and commits. Cross-referencing the actual repo files ensures the README reflects the true state of the repository.

Structure a repository README by applying a template that organizes source-based facts into Problem, Goal, Approach, Implemented Features, and Getting Started sections. This ensures the repo's content is presented in a clear, readable format.

Yes, manifest files like package.json, pyproject.toml, or Cargo.toml verify README content. Reading these files provides accurate dependency and project details to back up the documentation with verifiable provenance.

Yes, this approach works for any single repository with accessible source files and manifests. It locates the target repository's key directories and commits to ground the README draft in truth, regardless of the specific project.

Generated READMEs cite commit history to provide provenance and auditability for documented features. Referencing commits backs up the content and enables easy updates as the repository evolves over time.