accelint-readme-writer

Automated README generation works by recursively parsing your codebase from the README's directory to identify public APIs, then producing structured sections like Installation, Quick Start, and Examples. This process keeps documentation aligned with actual implementation functionality.

Updating existing READMEs involves analyzing the codebase to identify gaps between implementation and documentation, then suggesting changes to align API references with actual code. It focuses on editing current content rather than starting from scratch.

README generation works in monorepos by focusing the scope to the specific package containing the README and its boundaries. It recursively parses only that package's codebase to ensure the documentation reflects the correct package functionality.

Generated README documentation includes structured sections such as Installation, Quick Start, API, and Examples. The process provides section ordering guidance, copy-pasteable code blocks, and package manager detection to ensure a complete and practical template.

The optional humanizer step refines the tone of generated README content to ensure it reads naturally and sounds human-written. It applies writing style guidance after the initial documentation sections are produced from codebase analysis.

Keeping README documentation in sync involves analyzing the codebase from the README location to detect implementation gaps, then updating sections like API and Examples. This ensures documentation stays aligned with current functionality without manual tracking.