用途:该技能提供在 docsite(apps/docs/)中为 CDS 组件创建或更新文档的完整指引。若用户未给出组件名称,应先询问要记录哪个组件。
主要能力与工作方式:
- 检查已有文档,路径为 apps/docs/docs/components/*/[ComponentName]/。若已存在,则结合用户补充信息识别需新增、更新或改进的内容,只针对需要改进的部分,不必整体重写;若不存在,则按完整流程新建。
- 编写前参考 LineChart、Button、IconButton、Sidebar 等已文档化组件,以统一风格、结构与深度;写示例时参考 packages/icons/src/IconName.ts 中的合法图标名,并通过 components-best-practices SKILL 了解合法 CDS 设计令牌值(Color、Space、BorderRadius、Font 等)。
- 新建或大幅更新前,先调研 Material UI、Radix UI、Mantine、Ant Design、Base UI 中同类组件的文档,关注其示例组织、常见用例、边界情况、无障碍指引及复杂特性的讲解方式。
- 核对组件存在位置:packages/web/src/[source-category]/[ComponentName].tsx 与 packages/mobile/src/[source-category]/[ComponentName].tsx;检查是否存在 Storybook story(packages/*/src/**/stories/[ComponentName].stories.tsx),若有则在 webMetadata.json 中添加 storybook 字段;检查组件类型定义是否支持 styles、classNames 属性,支持则应有 styles 标签页。
- 新建文档的必需配置:在 apps/docs/src/components/page/ReactLiveScope.ts 中导入组件并加入 scope;在 apps/docs/sidebars.ts 的分类(如 Buttons、Layout)items 中加入 'components/category/ComponentName/index';在 apps/docs/docgen.config.js 中为 web 及(如有)mobile 添加组件源码路径以生成 props 数据。
- 按平台创建目录与文件:index.mdx(必需)、webMetadata.json、_webExamples.mdx、_webPropsTable.mdx、_webStyles.mdx、mobileMetadata.json、_mobileExamples.mdx、_mobilePropsTable.mdx、_mobileStyles.mdx。资料给出了各文件的模板,包括 metadata 的 import、source、description、figma、storybook、relatedComponents、dependencies 字段说明;props 表使用 ComponentPropsTable 并引入 docgen 数据与共享类型;styles 文档对 web 使用 StylesExplorer 加 ComponentStylesTable,对 mobile 仅用 ComponentStylesTable,并说明需按组件 classNames 类型覆盖所有选择器、注意条件渲染、嵌套结构与可选内容。index.mdx 按仅 Web、仅移动端、跨平台三种情况给出了 frontmatter 与组件组合模板。
适用场景:维护 Coinbase CDS 组件库文档的开发者,在新增组件或修改组件后同步 docsite 文档时使用。
限制:资料未说明该技能的安装方式、独立运行命令、收费或价格、支持平台范围及文档生成效果;它依赖 CDS 仓库内的具体路径与配置,属于仓库内文档工作流,上述未提供的信息不做推断。