write-docs

Automate README updates by scanning entrypoints, public exports, and configuration defaults from source code to sync installation commands and usage flags directly. This ensures project-facing documentation accurately reflects the current codebase without manual editing.

API reference synchronization works by scanning your source files to extract function signatures, parameters, and return types directly. This process requires read access to project source files to verify technical accuracy against actual public exports.

Generate changelogs automatically by parsing Git commit history to create structured release notes based on Conventional Commits. This requires read access to git logs to verify commit signatures and map them to structured documentation.

Prevent documentation drift by synchronizing READMEs, API references, and changelogs with the actual codebase. Scanning entrypoints and git history ensures technical documentation remains accurate and aligned with evolving source code automatically.

Read access to project source files and git logs is required to sync project documentation. The synchronization process verifies signatures, configuration defaults, and commit history to ensure generated technical documentation remains accurate.

API references mismatch actual function signatures due to documentation drift during codebase evolution. Extracting signatures, parameters, and return types directly from source files ensures the API reference stays synchronized with the real code.