skills.rest
cloudflare
cloudflareOFFICIAL
Explore all skills by this author →
WebsiteGitHub

docs-review

Review documentation PRs for MDX syntax, frontmatter, style guide, and components.

5.1k|16.3k|Updated Sep 3, 2020
Search Tags:#review#docs#frontmatter#mdx#style-guide#pull-request
One-click install
npx skills add https://github.com/cloudflare/cloudflare-docs --skill docs-review-cloudflare
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-review
Source: https://github.com/cloudflare/cloudflare-docs/tree/main/.agents/skills/docs-review
Command: npx skills add https://github.com/cloudflare/cloudflare-docs --skill docs-review-cloudflare

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps documentation teams review PRs efficiently by providing structured feedback that ensures MDX correctness, frontmatter validation, style-guide compliance, and proper component usage.

Core Features & Use Cases

  • Automates checks for MDX syntax, frontmatter validity, and adherence to the style guide.
  • Suggests targeted edits and inline guidance to improve clarity, consistency, and accuracy in docs content.
  • Use Case: A maintainer opens a docs PR; the skill analyzes changes and guides the reviewer toward precise improvements.

Quick Start

Run a docs PR review to receive actionable feedback and inline suggestions.

Frequently Asked Questions about docs-review

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

FAQPage Schema
How do I automate documentation PR reviews for MDX syntax and frontmatter validity?▼

Automate documentation PR reviews by applying best-practice checks for MDX syntax and frontmatter validity. This skill analyzes pull request changes and provides structured, actionable feedback to ensure MDX correctness and proper component usage.

What is the best way to check style-guide adherence in docs pull requests?▼

The best way to check style-guide adherence in docs pull requests is using automated review skills that evaluate content against AGENTS.md rules. This ensures consistent, actionable feedback for reviewers and maintains documentation clarity and accuracy.

Does this docs review skill work with GitHub PR workflows?▼

Yes, the docs review skill works with GitHub PR workflows by analyzing changes and guiding reviewers toward precise improvements. It applies checks for MDX syntax, frontmatter validity, and component usage directly within your pull request process.

How do I validate frontmatter and component usage in MDX documentation?▼

Validate frontmatter and component usage in MDX documentation by running automated docs PR reviews. The skill identifies best-practice checks, handles edge cases, and suggests targeted edits to improve consistency and accuracy in your content.

What checks are included in a docs PR review for style-guide compliance?▼

A docs PR review for style-guide compliance includes checks for MDX syntax, frontmatter validity, component usage, and alignment with AGENTS.md content rules. It provides inline guidance and structured feedback to improve clarity and consistency.

Related Skills

Explore More Content & Communication Skills→
leynosleynos
2

code-review

Review pull requests for correctness, style, security, and architecture.

Community
Advanced
elijahmurrayelijahmurray
2

pr-create

Create pull requests and validate documentation before submission.

Community
Basic
mt-krainskimt-krainski
1

wrap

Automate branch completion with code review, linting, testing, commits, and Pull Request creation.

Community
Advanced
ddttomddttom

md-workflow

Create, edit, and lint Markdown files with YAML frontmatter awareness.

Community
Intermediate