Skills
.Work. You
Rest

x-validate-docs

Community

Keeps docs in sync with code changes.

Software Engineering#documentation#validation#drift#pr#report#ci
Authoredercnj
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Keeps code and documentation in sync by validating that documentation updates exist for altered code across key dimensions (readme, api, adr, skill-docs, etc.) in PRs and branches, reducing drift and review overhead.

Core Features & Use Cases

  • Validates documentation across six dimensions (readme, api, adr, skill-docs, system-architecture, and governance references) per PR.
  • Generates a structured report to a user-specified path or stdout, and exits with 0 on pass and 1 on failure for CI integration.
  • Supports story-id and PR-number filtering and scope-limiting to specific paths.

Quick Start

Run the detector on a PR to produce a report at the desired path.

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: x-validate-docs
Download link: https://github.com/edercnj/ia-dev-environment/archive/main.zip#x-validate-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.