update-component-docs
A management tool that tracks and updates component documentation files when the source code API changes.
Install
mkdir -p .claude/skills/update-component-docs && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/9240" && unzip -o skill.zip -d .claude/skills/update-component-docs && rm skill.zipInstalls to .claude/skills/update-component-docs
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
Update component documentation when code changesKey capabilities
- →Sync component API tables in VitePress
- →Update Storybook args and controls
- →Verify component usage examples
- →Update CSS custom properties and tokens
How it works
The skill locates component files and documentation, identifies changes in APIs or tokens, and proposes updates across VitePress, Storybook, and framework-specific examples.
Inputs & outputs
When to use update-component-docs
- →Updating component API tables
- →Syncing props documentation after refactor
- →Updating component usage examples
About this skill
Usage: /update-component-docs COMPONENT_NAME
Examples:
/update-component-docs button/update-component-docs alert
Update docs for component: $ARGUMENTS
Setup:
- Read
.claude/PROJECT_CONTEXT.mdfor AgnosticUI structure and paths
Process:
- Locate component files:
Read v2/lib/src/components/$ARGUMENTS*
Read v2/site/docs/components/$ARGUMENTS.md
Glob v2/playgrounds/*/src/stories/*$ARGUMENTS*
Glob v2/examples/*/src/*$ARGUMENTS*
-
Identify what changed:
- Core component API (props, slots, events)
- CSS custom properties or design tokens
- Behavior or interaction patterns
- Accessibility features
- Breaking changes vs additions
-
Check related documentation:
- VitePress component page for API tables and usage examples
- Storybook stories across Lit, React, and Vue playgrounds
- Example implementations in each framework
- Related playbook if component has specific use case docs
- Design tokens if styling/theming changed
-
Propose documentation updates:
- VitePress: Update props tables, events, slots, CSS custom properties, usage examples
- Storybook stories: Update args, controls, story descriptions across all three frameworks
- Examples: Verify examples still work with new API
- Playbooks: Update if related to specific workflow/pattern
- Design tokens: Note if component uses new/changed tokens
-
WAIT FOR USER APPROVAL
-
Update consistently across frameworks:
- Ensure Lit, React, and Vue stories show equivalent functionality
- Use framework-appropriate syntax but consistent examples
- Same terminology and descriptions across all docs
- Code examples match current API
- Note framework-specific differences where relevant
-
Verify completeness:
- All frameworks (Lit, React, Vue) documented
- VitePress and Storybook in sync
- Examples updated if API changed
- Design token references accurate
Token Optimization:
- Start with core component to understand changes
- Only read framework-specific files if API differs by framework
- Skip playbooks unless component has dedicated workflow docs
- Check design tokens only if styling/theming aspects changed
When not to use it
- →Updating documentation for non-component files
Prerequisites
Limitations
- →Requires user approval for all proposed changes
- →Limited to AgnosticUI component structure
How it compares
It automates cross-framework synchronization for Lit, React, and Vue, whereas manual updates require individual edits for each implementation.
Compared to similar skills
update-component-docs side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| update-component-docs (this skill) | 0 | 6mo | No flags | Intermediate |
| ui-ux-pro-max | 1,909 | 5mo | Review | Intermediate |
| screenshot-to-code | 204 | 2mo | No flags | Beginner |
| web-component-design | 5 | 5mo | No flags | Intermediate |
Try saying
Example prompts that trigger this skill in your AI assistant.
More by AgnosticUI
View all by AgnosticUI →You might also like
ui-ux-pro-max
nextlevelbuilder
UI/UX design intelligence. 50 styles, 21 palettes, 50 font pairings, 20 charts, 8 stacks (React, Next.js, Vue, Svelte, SwiftUI, React Native, Flutter, Tailwind). Actions: plan, build, create, design, implement, review, fix, improve, optimize, enhance, refactor, check UI/UX code. Projects: website, landing page, dashboard, admin panel, e-commerce, SaaS, portfolio, blog, mobile app, .html, .tsx, .vue, .svelte. Elements: button, modal, navbar, sidebar, card, table, form, chart. Styles: glassmorphism, claymorphism, minimalism, brutalism, neumorphism, bento grid, dark mode, responsive, skeuomorphism, flat design. Topics: color palette, accessibility, animation, layout, typography, font pairing, spacing, hover, shadow, gradient.
screenshot-to-code
OneWave-AI
Convert UI screenshots into working HTML/CSS/React/Vue code. Detects design patterns, components, and generates responsive layouts. Use this when users provide screenshots of websites, apps, or UI designs and want code implementation.
web-component-design
wshobson
Master React, Vue, and Svelte component patterns including CSS-in-JS, composition strategies, and reusable component architecture. Use when building UI component libraries, designing component APIs, or implementing frontend design systems.
visual-design-foundations
wshobson
Apply typography, color theory, spacing systems, and iconography principles to create cohesive visual designs. Use when establishing design tokens, building style guides, or improving visual hierarchy and consistency.
fumadocs-component-docs
TheOrcDev
Create component documentation with installation, usage examples, and preview sections. Apply when documenting 8-bit components with proper structure and examples.
web-development
TencentCloudBase
Web frontend project development rules. Use this skill when developing web frontend pages, deploying static hosting, and integrating CloudBase Web SDK.