repo2readme

tree-sitter parsing · map-reduce · source verification

READMEs grounded
in the code.

Paste a public GitHub repository. repo2readme parses every file, summarizes it in two passes, and checks each path, symbol and command against the source. The architecture diagram is drawn from real imports.

Try

How it works

Facts first, then the model, then a checker.

  1. 01

    Parse

    Shallow clone, skip vendored and generated files, and extract every definition and import with tree-sitter. Manifests give scripts, dependencies and env vars.

  2. 02

    Map

    Files are packed into chunks without truncation. Each file gets a summary where every fact cites the line range it came from.

  3. 03

    Reduce

    Verified summaries, the module import graph and manifest facts are combined into a README draft, via module summaries for large repos.

  4. 04

    Verify

    Paths, symbols, commands and flags that don't exist are removed or repaired. Diagram arrows come only from resolved imports.