documentation-generator

To automatically generate and sync project documentation, you run a tool that scans your codebase, extracts metadata, and fills markdown templates for README.md, LLM-OVERVIEW.md, and ADRs to keep docs aligned with code changes.

An LLM-OVERVIEW.md file documents your project's architecture and current state for AI models. You generate it when you want to provide large language models with a structured technical overview of your codebase.

Yes, the documentation generation process supports template-based customization, allowing you to define and populate specific markdown templates for README.md sections like quick start, features, and configuration.

The best way to track architectural decisions is by using a tool that automatically outputs ADRs, or Architecture Decision Records, and syncs them with code changes to ensure your architectural history stays aligned.

Yes, the documentation generator operates with no external dependencies, allowing you to directly scan your codebase and extract metadata to produce markdown artifacts within a self-contained workflow.