smithery/agnosticui

update-component-docs

Update component documentation when code changes

Installation

$ npx skills add smithery/agnosticui --skill update-component-docs

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

Also in this package

Other skills from smithery/agnosticui.

npx skills add smithery/agnosticui

Browse all from smithery/agnosticui

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Skill metadata

Parsed from SKILL.md frontmatter.

Allowed toolsRead, Grep, Glob
Declared agents claude-code

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 2,425 B
  • docs SUMMARY.md 77 B

History

  1. First recorded snapshot · 0 installs

SKILL.md

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

  1. 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

  1. 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

  1. WAIT FOR USER APPROVAL
  1. 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

  1. 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