Update Component Reference
Automates the documentation process for Claude Code components by generating standardized MDX files for commands, agents, skills, hooks, and MCP servers.
The source repository doesn't declare a license. Check its terms before reusing the code.
Key features
- Automatic integration of source code via raw-loaders for real-time documentation updates.
- Standardized plugin badge implementation for consistent visual branding.
- Automated MDX generation using specialized templates for commands, agents, and skills.
- Dynamic sidebar positioning based on existing documentation structure.
- Cross-reference validation for skill registration within plugin configuration files.
Use cases
- Adding configuration details for new MCP servers or hooks to a developer portal.
- Updating existing reference documentation when a component's specification changes.
- Documenting a newly created custom command or agent within the Claude Code handbook.
FAQ
When should I use this skill?
You should use this skill whenever you add a new component to a Claude Code plugin or need to update existing reference documentation. It is specifically designed to bridge the gap between source code and the website's Component Reference section.
Does it support automated badge and sidebar management?
Yes. The skill dynamically determines the 'sidebar_position' by scanning existing files and automatically applies the correct plugin-specific CSS badges (e.g., 'handbook' or 'handbook-dotnet') to maintain visual consistency across the site.
How does this skill improve the documentation workflow?
It eliminates manual formatting errors by using specialized templates and automatically calculates the correct sidebar position. It also uses raw-loaders to pull source code directly into the documentation, ensuring your docs stay in sync with your actual code.
What does the Update Component Reference skill do?
This skill automates the creation of standardized MDX documentation for Claude Code components. it handles the generation of files for commands, agents, skills, hooks, and MCP servers while ensuring they follow the correct formatting and directory structure.
What are the prerequisites for documenting a new skill?
Before running the skill, the component must exist in the appropriate plugin directory. Specifically for skills, the component must also be registered in your 'plugin.json' file to ensure it is correctly indexed and available.
Related skills
Claude Docs Consultant
Retrieves real-time, official Claude Code documentation via selective fetching to ensure accurate implementation of hooks, skills, and subagents.
Learning Documentation1,44712 ptsClaude Code Skills
Facilitates the creation and optimization of specialized capabilities for Claude Code through standardized architecture and development workflows.
Learning Documentation212 ptsInstruction Writer
Writes and optimizes clear, token-efficient instructions for all Claude Code components, including skills, commands, and documentation.
Learning Documentation212 pts