Skip to content
cccskills
FreePublished on GitHub

update-component-docs

Update component documentation when code changes

The English summary is being prepared. Showing the original description.

See how to install

Files included (1)

  • SKILL.md2.4 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

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:

  1. 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*
  1. 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
  2. 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
  3. 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
  4. WAIT FOR USER APPROVAL

  5. 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
  6. 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

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

Review component for accessibility issues

The English summary is being prepared. Showing the original description.

AgnosticUI/agnosticui828Updated Oct 12, 2026

Explain what code does in plain English

The English summary is being prepared. Showing the original description.

AgnosticUI/agnosticui828Updated Oct 12, 2026

Fix a GitHub issue by number. Use when asked to fix GitHub issues.

The English summary is being prepared. Showing the original description.

AgnosticUI/agnosticui828Updated Oct 12, 2026

Implement a playbook from its PROMPT specification files. Supports both single-framework (PROMPT-REACT.md, etc.) and 3-framework (PROMPT-3-FRAMEWORKS.md) modes.

The English summary is being prepared. Showing the original description.

AgnosticUI/agnosticui828Updated Oct 12, 2026

Design and implement a new feature or component from a GitHub issue. Use for net-new functionality, not bug fixes.

The English summary is being prepared. Showing the original description.

AgnosticUI/agnosticui828Updated Oct 12, 2026

See all skills by AgnosticUI

Report a problem with this skill