documentation-reviewer

To keep MkDocs documentation aligned with code changes, analyze git diffs to identify impacted pages and map modifications to documentation targets. This process highlights inconsistencies and generates MkDocs Material formatting patterns to update docs automatically.

Analyze a git diff to find required documentation updates by running a Python script that processes recent commits. It identifies affected pages, applies predefined mapping rules, and reports actionable gaps between code modifications and existing documentation.

The best way to track gaps between code and MkDocs docs is to execute diff analysis against recent repository commits. This maps code modifications to predefined documentation targets and reports missing or inconsistent pages requiring updates.

Yes, documentation review works with MkDocs Material by generating and applying formatting patterns to updated docs. It ensures newly identified changes from the git diff are reflected with the correct MkDocs Material styling and structure.

Yes, you can use an included Python script to automate MkDocs documentation maintenance. Running the script from the repository root executes diff analysis, generates actionable documentation targets, and supports automated formatting updates.

MkDocs pages fall out of sync with recent git commits when code modifications are not mapped to corresponding documentation targets. Analyzing the diff identifies these impacted pages and reports the specific gaps requiring updates.