update-component-docs

Solid

Update component documentation when code changes

Web & Frontend 810 stars 47 forks Updated 3 weeks ago Apache-2.0

Install

View on GitHub

Quality Score: 92/100

Stars 20%
97
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

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
3 weeks ago
Language
TypeScript
License
Apache-2.0

Integrates with

Related Skills