review-doc

Run sequential documentation audits on MR/PRs and post feedback.

41|7|Updated Jan 30, 2026
One-click install
npx skills add https://github.com/DGouron/review-flow --skill review-doc-dgouron
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review-doc
Source: https://github.com/DGouron/review-flow/tree/main/.claude/skills/review-doc
Command: npx skills add https://github.com/DGouron/review-flow --skill review-doc-dgouron

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation reviews are labor-intensive and error-prone when performed manually on MR/PRs. This skill automates a structured, multi-audit review to ensure quality, consistency, and up-to-date terminology across documentation.

Core Features & Use Cases

  • Sequential audits: markdown-quality, link-validity, terminology, freshness, and examples-validity.
  • Read-only safety: generates a comprehensive report without modifying source docs and posts feedback to the MR/PR.
  • Report automation: produces a polished Markdown review document stored under .claude/reviews for traceability.

Quick Start

Activate the documentation-review skill on a MR/PR to generate a sequential five-audit doc review and feedback report.

Frequently Asked Questions about review-doc

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

FAQPage Schema
How do I automate documentation reviews on merge requests?

Automate documentation reviews on merge requests by running sequential audits that check markdown quality, link validity, terminology, freshness, and examples. The process generates a consolidated report and posts feedback directly to the MR while remaining read-only to source docs.

Can I check markdown link validity and terminology consistency in pull requests?

Yes, you can check markdown link validity and terminology consistency in pull requests through a sequential five-audit pipeline. It evaluates markdown-quality, link-validity, terminology, freshness, and examples-validity, then posts the automated feedback to the PR.

What is a sequential documentation audit for MRs and PRs?

A sequential documentation audit for MRs and PRs is a structured review process that coordinates five audits in sequence via an orchestrator. It enforces quality, consistency, and up-to-date terminology across markdown docs in documentation-heavy projects.

Does automated doc review modify source files in the repository?

Automated doc review does not modify source files in the repository. It operates with read-only safety, generating a comprehensive markdown review document stored under .claude/reviews for traceability and posting feedback to the MR or PR without altering source docs.

How do I enforce up-to-date terminology across markdown documentation?

Enforce up-to-date terminology across markdown documentation by applying an automated terminology audit within a sequential review pipeline. The orchestrator coordinates the terminology check alongside other audits and produces a consolidated doc-review report for your MR or PR.

Is automated documentation review suitable for documentation-heavy projects?

Automated documentation review is specifically designed for documentation-heavy projects where quality, consistency, and up-to-date terminology must be enforced. It automates the labor-intensive manual review process to reduce errors across markdown docs in MRs and PRs.