skills.rest
ribatshepo
ribatshepoCOMMUNITY
Explore all skills by this author →
GitHub

docs-review

Detect style-guide violations in Markdown files and PR diffs with inline feedback.

Updated Aug 23, 2026
Search Tags:#documentation#markdown#review#lint#style-guide#inline-comments#pr-review
One-click install
npx skills add https://github.com/ribatshepo/cc-auto-orchestrate --skill docs-review-ribatshepo
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-review
Source: https://github.com/ribatshepo/cc-auto-orchestrate/tree/main/claude-code/skills/docs-review
Command: npx skills add https://github.com/ribatshepo/cc-auto-orchestrate --skill docs-review-ribatshepo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Helps teams enforce documentation quality by automatically detecting style-guide violations in Markdown files and PR diffs.

Core Features & Use Cases

  • Inline feedback: comments directly on markdown changes in PRs.
  • Local and PR reviews: supports both local file checks and GitHub PR review workflows with a consolidated pending review when possible.
  • Style-guide aware: references a centralized style guide to ensure consistency across docs.

Quick Start

Review a Markdown file in a local repo or a PR, and let the skill point out style violations with inline guidance.

Frequently Asked Questions about docs-review

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

FAQPage Schema
How do I check markdown documentation for style-guide violations?▼

To check markdown documentation for style-guide violations, use an automated review skill that references a centralized style guide to detect inconsistencies and report them with inline comments.

Can I automate PR review for documentation changes?▼

Yes, you can automate PR review for documentation changes. When an integration tool is available, the skill operates in PR review mode to provide inline feedback directly on markdown diffs.

How do I lint markdown files locally for style consistency?▼

You can lint markdown files locally by running the skill in local review mode, which analyzes your documentation against a shared style-guide reference and outputs inline feedback for style violations.

What is required to automate documentation style checks?▼

Automating documentation style checks requires markdown files and a shared style-guide reference. Frontmatter must declare a name and description, and an integration tool is needed to enable PR review mode.

Does documentation review work without a GitHub PR integration tool?▼

Yes, documentation review works without a GitHub PR integration tool. If no integration is available, the skill automatically performs a local review of your markdown files and provides inline feedback.

Related Skills

Explore More Content & Communication Skills→
hashicorphashicorp
78

quick-styleguide

Automates HashiCorp style-guide validation for Markdown documentation files.

Official
Basic
Open330Open330
1

looping-pr-reviews

Loop through GitHub PR reviews, analyze feedback, and apply fixes until approval.

Official
Intermediate
metabasemetabase
48.6k

docs-review

Review documentation diffs for Metabase writing style compliance.

Official
Basic
mwathibenmwathiben

docs-review

Identify style violations in documentation diffs against the Metabase writing style guide.

Community
Advanced