update-component-docs
SolidUpdate component documentation when code changes
Web & Frontend 812 stars
47 forks Updated 1 months ago Apache-2.0
Install
Quality Score: 92/100
Stars 20%
Recency 20%
Frontmatter 20%
Documentation 15%
Issue Health 10%
License 10%
Description 5%
Skill Content
**Usage:** `/update-component-docs COMPONENT_NAME`
**Examples:**
- `/update-component-docs button`
- `/update-component-docs alert`
Update docs for component: $ARGUMENTS
**Setup:**
1. Read `.claude/PROJECT_CONTEXT.md` for AgnosticUI structure and paths
**Process:**
2. **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*
```
3. **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
4. **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
5. **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
6. **WAIT FOR USER APPROVAL**
7. **Update consi...
Details
- Author
- AgnosticUI
- Repository
- AgnosticUI/agnosticui
- Created
- 5 years ago
- Last Updated
- 1 months ago
- Language
- TypeScript
- License
- Apache-2.0
Integrates with
Similar Skills
Semantically similar based on skill content — not just same category
Data & Documents Listed
update-docs
Keep project documentation current by researching latest patterns, fetching sources, and updating docs with findings
79 Updated 1 months ago
escapeboy AI & Automation Listed
docs
Update documentation to match implementation
10 Updated 6 days ago
jmylchreest Data & Documents Listed
documentation
Update stale documentation and comments to match current code
0 Updated 3 days ago
AnotherSava AI & Automation Solid
doc-updates
Update documentation after code changes with quality gates, slop detection, consolidation, and accuracy verification.
297 Updated today
athola AI & Automation Listed
update-docs
Update all project documentation after code changes.
29 Updated 2 months ago
lbb00