docs-writer-reference

Standardize React reference documentation with template-driven MDX content.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps content writers and software teams produce consistent reference documentation for React APIs by applying a shared frontmatter schema and standardized MDX templates.

Core Features & Use Cases

  • Templates and patterns for Reference pages (Type A-F), including hooks, components, configurations, directives, ESLint rules, and category indexes.
  • Guidance on page structure, inline navigation (InlineToc), canary/adoption notes, and page-level deprecation rules.
  • Use cases include creating new reference pages, auditing existing docs for consistency, and enabling tooling to enforce frontmatter and heading conventions.

Quick Start

Create a new Skill unit by adding a SKILL.md with name and description at the root of the unit, and place optional resources under scripts/, references/, or assets/ as needed.

Frequently Asked Questions about docs-writer-reference

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

FAQPage Schema
How do I standardize React reference documentation for hooks and components?

To standardize React reference documentation, apply a strict SKILL.md frontmatter schema and template-driven MDX content for hooks, components, and APIs to ensure consistent structure and style across all pages.

What is the required frontmatter format for React reference docs?

The required frontmatter format for React reference docs uses a SKILL.md file at the skill unit root, mandating name and description fields to standardize metadata across hooks, components, and configurations.

How do I structure MDX reference pages with InlineToc and Canary sections?

To structure MDX reference pages with InlineToc and Canary sections, apply the Skill unit's template-driven content patterns to standardize inline navigation, canary adoption notes, and page-level deprecation rules.

Can I use reference templates for auditing existing React API docs?

Yes, you can use reference templates for auditing existing React API docs by validating their frontmatter schema and heading conventions against the standardized MDX patterns to enforce content consistency.

Do I need specific scripts or folders to generate React reference pages?

You need a root SKILL.md file for name and description, while scripts, references, and assets folders are optional for supplying tooling and assets required to generate React reference pages.