update-component-reference

Generate MDX documentation for Claude Code components with sidebar positions.

137|20|Updated Jun 13, 2025
One-click install
npx skills add https://github.com/NikiforovAll/claude-code-rules --skill update-component-reference
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-component-reference
Source: https://github.com/NikiforovAll/claude-code-rules/tree/main/.claude/skills/update-component-reference
Command: npx skills add https://github.com/NikiforovAll/claude-code-rules --skill update-component-reference

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill streamlines the process of adding or updating documentation for Claude Code components (commands, agents, skills, hooks, MCP servers) on the skills.rest website. It ensures that new components are consistently documented, correctly formatted, and easily discoverable, eliminating manual documentation overhead.

Core Features & Use Cases

  • Automated Documentation Generation: Creates .mdx files with correct frontmatter, titles, and import paths for various component types.
  • Sidebar Position Management: Automatically determines the appropriate sidebar_position for new entries, maintaining organized navigation.
  • Use Case: After developing a new /refactor command, use this skill to automatically generate its documentation page on the website, ensuring it's properly formatted, linked in the component reference, and immediately accessible to users.

Quick Start

Create a new MDX documentation file for a skill

touch website/docs/component-reference/skills/my-new-skill.mdx

Then, fill the file with the appropriate template content provided by the skill.

Frequently Asked Questions about update-component-reference

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

FAQPage Schema
How do I create documentation for Claude Code components?

Create documentation by generating an `.mdx` file in `website/docs/component-reference/{type}` with proper frontmatter, title, and import path. The Skill automates this process for commands, agents, skills, hooks, and MCP servers, ensuring consistent formatting and correct sidebar positioning.

What MDX template structure should I use for component reference docs?

MDX documentation requires frontmatter with sidebar_position, a title matching the component name, and import statements for Claude Code components. The Skill enforces correct template usage and validates import paths to maintain consistency across the component reference.

How do I ensure new components appear in the correct navigation order?

The Skill automatically determines the appropriate `sidebar_position` for new documentation entries, eliminating manual calculation. It maintains organized navigation by calculating position based on existing entries in the target component-reference directory.

What prerequisites must be met before documenting a component?

Components must exist in correct directories, skills require `plugin.json` registration, and all entries must follow MDX/template standards. The Skill enforces these prerequisites and validates directory placement before generating documentation.

Can I use this to update existing component documentation?

Yes, the Skill applies to both creating new entries and updating existing documentation. It handles modification of commands, agents, skills, hooks, and MCP server docs while maintaining proper formatting and import path validation.

What file formats and locations does the component reference support?

Documentation uses `.mdx` files stored in `website/docs/component-reference/{type}` directories organized by component type. MDX enables both markdown content and React component integration for interactive documentation.