docs-check

Detect user-facing changes and write a JSON checkpoint to .checkpoints/docs-check.json.

147|10|Updated Nov 17, 2025
One-click install
npx skills add https://github.com/GGPrompts/TabzChrome --skill docs-check-ggprompts
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-check
Source: https://github.com/GGPrompts/TabzChrome/tree/main/plugins/conductor/skills/docs-check
Command: npx skills add https://github.com/GGPrompts/TabzChrome --skill docs-check-ggprompts

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Docs-check detects whether changes are user-facing and ensures documentation hygiene by processing diffs and generating a checkpoint.

Core Features & Use Cases

  • Detects user-facing changes and enforces documentation hygiene.
  • Analyzes diffs to verify changelog updates or bypass labels, and outputs a JSON checkpoint.
  • Writes the checkpoint to .checkpoints/docs-check.json for traceability.

Quick Start

Run the docs-check tool after making changes to generate the checkpoint file at .checkpoints/docs-check.json.

Frequently Asked Questions about docs-check

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

FAQPage Schema
How do I automate documentation checks for user-facing changes before a release?

Automated documentation checks detect user-facing changes by analyzing git diffs to enforce documentation hygiene, verifying changelog updates or bypass labels before a release.

What is the best way to enforce changelog governance and trace documentation updates?

Changelog governance is enforced by analyzing code diffs to verify changelog updates, generating a JSON checkpoint to provide traceability and ensure documentation hygiene.

Do I need any external dependencies to run documentation audits with git?

No external dependencies are needed to run documentation audits beyond git and standard tooling, which classify changes and generate the required checkpoint file.

How does a documentation audit generate traceability for release validation?

A documentation audit generates traceability by analyzing diffs, classifying user-facing changes, and writing a persistent JSON checkpoint file to a designated checkpoints directory.

Can I use bypass labels to skip changelog updates for internal modifications?

Yes, you can use bypass labels to skip changelog updates, allowing the diff analysis to classify internal modifications and pass the documentation hygiene checkpoint.

Why is my documentation hygiene check not detecting user-facing changes properly?

Documentation hygiene checks fail to detect changes when the diff analysis lacks proper context or bypass labels are incorrectly applied during the release validation process.