documentation-reviewer

Community

Keep docs aligned with code changes.

Authorkettleofketchup
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill ensures MkDocs documentation stays synchronized with code changes by analyzing git diffs, identifying impacted docs, and updating formatting to reflect new or changed behavior.

Core Features & Use Cases

  • Analyze diffs to map code changes to relevant documentation pages.
  • Highlight gaps and inconsistencies between code and docs.
  • Generate and apply MkDocs Material formatting patterns to updated docs.

Quick Start

Run the analysis on the latest commits from the repository root: python3 .claude/skills/documentation-reviewer/scripts/analyze_changes.py

Dependency Matrix

Required Modules

None required

Components

scripts

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: documentation-reviewer
Download link: https://github.com/kettleofketchup/dotfiles/archive/main.zip#documentation-reviewer

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.