documentation-reviewer

Name: documentation-reviewer
Availability: InStock
Author: KettleOfKetchup

Analyze git diffs to identify required MkDocs documentation changes.

Updated May 19, 2024

Search Tags:#git #documentation #diff #docs #documentation-review #mkdocs

Ready to run

npx skills add https://github.com/kettleofketchup/dotfiles --skill documentation-reviewer

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-reviewer
Source: https://github.com/kettleofketchup/dotfiles/tree/main/.claude/skills/documentation-reviewer
Command: npx skills add https://github.com/kettleofketchup/dotfiles --skill documentation-reviewer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

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

Frequently Asked Questions about documentation-reviewer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I keep MkDocs documentation aligned with git code changes?▼

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.

How do I analyze a git diff to find required documentation updates?▼

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.

What is the best way to track gaps between code and MkDocs docs?▼

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.

Does documentation review work with MkDocs Material formatting?▼

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.

Can I use a Python script to automate MkDocs documentation maintenance?▼

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.

Why are my MkDocs pages out of sync with recent git commits?▼

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.