pre-commit-docs

Official

Keep docs and CLAUDE.md in sync before commits

AuthorNimbusPowered
Version1.0.0
Installs0

System Documentation

What problem does it solve?

It prevents documentation and the CLAUDE.md project reference from drifting out of date with code changes, avoiding incorrect or stale guidance being committed.

Core Features & Use Cases

  • Staged-change impact analysis: Detects what code paths were modified in and around api, events, console commands, configuration, scaling, proxying, and related modules to determine which docs may need updates.
  • Targeted CLAUDE.md verification: Confirms key CLAUDE.md sections (modules, architecture tree, tech stack, configuration, patterns, and API details) still match the current codebase.
  • Minimal, precise doc updates: Flags only the documentation that actually contradicts or is missing information, instead of rewriting entire sections.
  • Pre-commit enforcement flow: Runs automatically on git commit via a PreToolUse hook, with a manual fallback invocation.

Quick Start

Commit your changes and ensure the documentation check runs automatically before the commit finalizes.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 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: pre-commit-docs
Download link: https://github.com/NimbusPowered/Nimbus/archive/main.zip#pre-commit-docs

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.