mcpbeat

Update Component Docs

agnosticui/update-component-docs

Update component documentation when code changes

606 tokens
context cost
the whole folder, loaded on every use
1
files
instructions only
0
copies elsewhere
how many repositories repackaged it
822
stars on the repo
on the repository, not the skill itself

Install

one command, takes just this skill from the repository
npx skills add https://github.com/AgnosticUI/agnosticui --skill update-component-docs

The instruction itself

as written by the author

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.md for 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

How to use it

Copy the folder

Take agnosticui/update-component-docs from the repository into ~/.claude/skills for personal use, or into .claude/skills inside a project.

Check the name does not clash

The agent identifies a skill by the name field in its header. Two skills with the same name cannot sit side by side — one of them will be ignored.