update-docs

You can automatically update documentation by scanning source code to identify public APIs and docstrings, then rewriting README.md, CLAUDE.md, and notebooks to reflect the current codebase. This syncs all relevant files while preserving existing formats and styles.

Keeping documentation in sync after refactoring requires reading source files and diffing them against existing docs. This process rewrites Markdown files and notebooks to accurately represent the updated module invariants and public APIs, preventing outdated information.

Yes, automated documentation updates preserve existing formats and styles. While the tool scans source files to rewrite README.md, CLAUDE.md, and user-guide notebooks with current codebase information, it maintains the original formatting of each documentation file.

Yes, you can update CLAUDE.md and user-guide notebooks alongside README.md automatically. The tool ensures cross-file consistency by reading source files and synchronizing all relevant Markdown documentation to reflect the current codebase state uniformly.

Documentation synchronization identifies updates by scanning source code to detect public APIs, docstrings, and module invariants. It then diffs these against existing documentation files to determine what changes need to be written back into the docs.

You should avoid using automated documentation sync when your source files lack structured public APIs or docstrings to scan. The tool relies on reading identifiable code structures to diff against existing docs and rewrite Markdown files accurately.