update-docs

To keep documentation in sync with code changes, analyze your branch diff using git diff canary...HEAD --stat, map the affected files to the relevant docs using your repository's code-to-docs mapping guidelines, and then update the documentation sections before merging.

The best way to automate documentation updates is to follow a structured workflow that analyzes code diffs, maps the changes to specific documentation sections, and validates the formatting with a lint check before preparing the final commit.

Diff analysis maps code changes to documentation sections by comparing branch differences, identifying the modified files, and cross-referencing them with a dedicated mapping guideline file to determine exactly which documentation entries require updates.

Yes, the documentation update workflow runs lint checks to validate formatting. It enforces a structured process that includes diff analysis, doc mapping, updates review, linting validation, and commit preparation to ensure docs are accurate before merging.

Yes, you can use this guided workflow to prepare documentation commits for pull requests. It provides step-by-step instructions to review changes, update the necessary docs, run lint validation, and prepare the final documentation updates for your PR.

You need a code-to-docs mapping file to accurately identify which documentation sections correspond to specific code changes. It serves as a reference guideline during diff analysis, ensuring that no affected documentation is missed when updates occur.