generate-component-documentation

自动生成新组件的完整技术文档,涵盖功能说明、属性接口、使用示例及可视化效果,严格遵循现有文档风格与故事实现逻辑,并嵌入指向 docs.rs 的 API 参考链接。

快捷安装

在终端运行此命令,即可一键安装该 Skill 到您的 Claude 中

npx skills add longbridge/gpui-component --skill "generate-component-documentation"

Instructions

When generating documentation for a new component:

  1. Follow existing patterns: Use the documentation styles found in the docs folder (examples: button.md, accordion.md, etc.)
  2. Reference implementations: Base the documentation on the same-named story implementation in crates/story/src/stories
  3. API references: Use markdown code blocks with links to docs.rs for component API references when applicable

Examples

The generated documentation should include:

  • Component description and purpose
  • Props/API documentation
  • Usage examples
  • Visual examples (if applicable)