document

Update README and API documentation by reading existing docs and code diffs to generate clear updates, runnable examples, and changelog entries. This ensures your project documentation accurately reflects the latest public interfaces and feature summaries.

Automate architecture docs and migration guides by capturing design decisions, upgrade paths, and breaking changes from code diffs. This documentation automation keeps your architecture notes accurate and aligned with new releases without introducing source modifications or TODO placeholders.

Validate code samples and links inside API documentation by reading existing docs and diffs to ensure accuracy. The validation process checks that runnable examples work correctly and that no broken links or TODO placeholders remain in your updated documentation.

Yes, you can generate changelog entries and migration guides without modifying source code. The documentation update process ensures no source modifications or TODO placeholders are introduced, keeping your project docs accurate while leaving the actual codebase untouched.

You need to update API references and architecture notes when code changes introduce new public APIs, architecture decisions, migrations, or releases. Keeping documentation accurate at these points ensures users and engineers can rely on up-to-date guidance.