Automated README generator — keep your docs in sync
Keeping a README synchronized with your codebase is a constant challenge. Features change, flags are deprecated, and installation steps evolve. Manual updates fall through the cracks—until someone tries to onboard and realizes the documentation is outdated.
Why Most README Tools Fall Short
Template-based generators produce generic outputs that don't reflect your actual code. They might add standard sections, but they can't tell you what your project actually does, what dependencies it requires, or how to run your specific commands.
How legacy-doc-ai Works
Unlike template generators, legacy-doc-ai analyzes the codebase itself. It parses your repository structure, identifies entry points, extracts dependency declarations, and scans existing code comments. The result is a README that accurately reflects what your project does—not what a generic template assumes.
Key Features
- Code-based generation: Scans your actual source files, not pre-made templates.
- Stale detection: Identifies when documentation has drifted from the codebase and flags outdated sections.
- --dry-run mode: Preview the generated README before writing anything to your repository.
Workflow
Run the tool with --dry-run first to review what would be generated. Inspect the diff, make any manual tweaks if needed, then run without the flag to update your README. The stale detection will continue to monitor for drift on future runs.
Get Started
Ready to automate your documentation workflow? See the install guide to get legacy-doc-ai running on your codebase.