SuperAPI AI 工具集

btst-docs

编程与开发

查看项目

更新于 10-16 05:01

技能介绍

用途:这是 BTST 的文档更新工作流,用于在插件、组件或 API 发生面向使用者的改动时,同步维护文档。文档是使用者的主要参考,不应跳过。

何时更新:为导出组件(如 ChatLayout、BlogLayout)新增 props;新增导出的类型或接口;改变现有 props 的行为;新增 hooks 或导出函数;新增或修改 API 端点及请求/响应结构;修改后端或客户端插件配置项;做破坏性变更(必须记录迁移路径)。

文件位置:docs/content/docs/plugins/ 下,如 blog.mdx、ai-chat.mdx、cms.mdx,按 {name}.mdx 创建或更新。

AutoTypeTable:可从 TypeScript 类型自动生成属性表,读取 JSDoc 注释,因此所有导出类型都应有 JSDoc。用法示例:import { AutoTypeTable } from "fumadocs-typescript/ui",然后在 Props 段落使用 <AutoTypeTable path="../../packages/stack/src/plugins/{name}/client/types.ts" name="MyComponentProps" />。JSDoc 示例中为 id 与 onSubmit 等字段添加说明注释。

验证构建:编辑后始终运行 cd docs && pnpm build,合并前修复所有 TypeScript 或 MDX 错误。

限制与注意:忘记更新文档是最常见的疏漏;若使用 AutoTypeTable,必须确保所有导出类型都有 JSDoc 注释,否则表格会渲染为空。资料未提供其他收费、平台或效果信息。