update-docs

Automatically update documentation to reflect source code changes by analyzing Git diffs against a main branch. The tool maps changed source files to their corresponding documentation pages using a defined strategy and makes targeted edits to reflect the code modifications.

Mapping source files to documentation pages works by using a defined mapping strategy that links specific source code files to their corresponding documentation pages. The tool analyzes code diffs and applies this mapping to make targeted edits, ensuring documentation stays synchronized with code modifications.

Yes, you need Git to keep docs in sync with code changes. The tool requires Git for diff analysis against a main branch and file system access for reading and writing the documentation pages that correspond to the modified source files.

The best way to update constructor parameters in docs after modifying a Python service is to use an automated documentation sync tool. It analyzes the code diff, maps the changed source file to its documentation page, and makes targeted edits to reflect the new parameters.

Yes, you can update multiple documentation pages at once. The tool analyzes the full code diff against the main branch, maps all changed source files to their respective documentation pages using the defined strategy, and applies targeted edits to each affected page.

A limitation of using Git diffs for documentation updates is that the tool relies on a defined mapping strategy to link source files to doc pages. If a documentation page lacks a mapping to the changed source file, the tool cannot automatically update it, requiring manual intervention.