review-docs

Validate React documentation structure, components, and style.

37|83|Updated Feb 13, 2019
One-click install
npx skills add https://github.com/reactjs/it.react.dev --skill review-docs-reactjs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review-docs
Source: https://github.com/reactjs/it.react.dev/tree/main/.claude/skills/review-docs
Command: npx skills add https://github.com/reactjs/it.react.dev --skill review-docs-reactjs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill provides a structured check for React documentation quality, focusing on consistency, clarity, and adherence to project style guidelines.

Core Features & Use Cases

  • Structured review prompts for documentation structure, components, and stylistic consistency.
  • Use cases include internal QA, contributor onboarding, and style-guide compliance checks.
  • Use Case: Imagine a team needing to align on terminology across tutorials and API docs; this skill highlights gaps and suggests fixes.

Quick Start

Run the review-docs skill against the target documentation folder to produce a structured compliance checklist.

Frequently Asked Questions about review-docs

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

FAQPage Schema
How do I check my React documentation for style and consistency?

You can review React documentation for style and consistency by validating structure, components, and frontmatter against project guidelines. This process surfaces gaps and produces a prioritized checklist of actionable fixes for remediation.

What is the best way to ensure terminology alignment across React tutorials and API docs?

The best way to ensure terminology alignment across tutorials and API docs is to run a structured compliance check. This highlights gaps in structure and components, suggesting fixes to align content with project style guidelines.

How do I generate a documentation compliance checklist for a repository?

You generate a documentation compliance checklist for a repository by running a review skill against the target documentation folder. It requires no external tooling beyond repository content and frontmatter, producing a prioritized list of issues for remediation.

Does the React docs review process require any external tooling or dependencies?

No, the React docs review process requires no external tooling or dependencies beyond the repository content and frontmatter. It analyzes guidelines, tutorials, and reference content internally to surface gaps and actionable fixes.

Can I use a documentation review process for contributor onboarding and internal QA?

Yes, you can use a documentation review process for contributor onboarding and internal QA. It provides structured review prompts for documentation structure and stylistic consistency, ensuring new contributors adhere to project style guidelines.