跳到正文
cccskills
免费在 GitHub 公开

update-component-docs

Update component documentation when code changes

中文简介正在准备中。当前显示原文说明。

查看安装方法

包含的文件(1)

  • SKILL.md2.4 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

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

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Review component for accessibility issues

中文简介正在准备中。当前显示原文说明。

AgnosticUI/agnosticui8282026年10月12日 更新

Explain what code does in plain English

中文简介正在准备中。当前显示原文说明。

AgnosticUI/agnosticui8282026年10月12日 更新

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

中文简介正在准备中。当前显示原文说明。

AgnosticUI/agnosticui8282026年10月12日 更新

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

中文简介正在准备中。当前显示原文说明。

AgnosticUI/agnosticui8282026年10月12日 更新

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

中文简介正在准备中。当前显示原文说明。

AgnosticUI/agnosticui8282026年10月12日 更新

查看 AgnosticUI 的全部技能

报告此技能的问题