SuperAPI AI 工具集

react-component-documentation

写作与研究

查看项目

更新于 10-16 05:48

技能介绍

用途:为 Sentry 组件创建或更新 MDX 格式的组件文档(stories),遵循 static/app/components/core/ 下的约定。

主要能力:先收集编辑性内容(何时使用、何时不用、各变体语义、常见误用、依赖的父级或 Provider、相关组件、值得配演示的 props),再定位组件源码,读取 props、类型、导出的子组件、枚举值与默认值,最后在组件目录旁生成 <component>.mdx。

使用方式:MDX 文件与组件同目录;若已存在则先读取再更新。文档结构按功能或用户可见变体组织,而非按 prop 名。每个功能小节需紧跟 <Storybook.Demo> 与对应代码块。@sentry/scraps 组件使用 type-loader 自动生成 API 文档,其他产品组件需手动编写 props 表格。导入顺序为外部包、Sentry 内部工具、@sentry/scraps 组件、Storybook 命名空间、type-loader。

适用场景:为 Sentry 前端组件编写或维护文档、添加 stories、补充可访问性说明与相关组件指引。

限制:资料仅覆盖 Sentry 仓库内的组件文档流程,未提供其他项目或框架的通用做法;未提及收费、价格或平台信息。