SuperAPI AI 工具集

component-guidelines-docs

设计与创作

查看项目

更新于 10-15 20:24

技能介绍

用途:为 SEED Design System 生成或更新组件指南文档(MDX),帮助产出结构一致、与 Rootage YAML 规范联动的设计指南。

主要能力:

  • 读取 /packages/rootage/components/{component-id}.yaml,从 definitions 提取 variant、size、state,从 metadata 取组件名,从 schema.slots 提取插槽,并生成 Props 表格。
  • 支持 simple 与 comprehensive 两种文档类型;comprehensive 可含 Anatomy、Guidelines、Comparison、Differences from V2 等章节。
  • 提供标准化图片路径命名规则(如 anatomy.webp、props-size.webp、guidelines-{topic}-{n}.webp、guidelines-{topic}-do-usage-1.webp、comparison-{a}-vs-{b}-1.webp 等),并给出 PNG 转 WebP 脚本用法:bun scripts/convert-images-to-webp.ts --path "docs/public/docs/components/{component-id}/**/*.png" --delete-original。
  • 提供可用文档组件:<PlatformStatusTable componentId="{id}" />、<ComponentSpecBlock id="{id}" />、<DoImage>、<DontImage>、<Grid>。
  • 韩语撰写规范,技术术语保留英文,使用敬语。

使用方式:先提供 Component ID(须与 YAML 文件名一致,文件须存在),可选 Documentation Type 及自定义章节(如 Anatomy 图片、Guidelines 主题、对比组件、是否含 V2 差异)。技能读取并解析 YAML 后生成 MDX,并附上待准备的图片路径清单与转换命令。

适用场景:新组件指南首次撰写、既有指南更新、V2 到 V3 迁移说明补充。

限制:依赖 Rootage YAML 文件存在;若缺失需用户提供路径或手动输入 Props;文档为韩国语风格;图片需用户自行准备。其余细节暂未提供。