名称: sync-docs 描述: 为fe-tools重新生成或验证文档。当用户要求更新文档、生成TypeDoc输出或验证文档对齐时使用。
同步文档
工作流
- 确保在
packages/*/src/index.ts中的导出API正确。 - 运行
npm run docs以生成TypeDoc输出。 - 如果文档出现错误,修复第一个报告的问题并重新运行。
该技能用于自动生成和验证前端工具fe-tools的文档,通过运行TypeDoc命令生成API文档输出,确保代码与文档对齐,提升开发效率和维护性。适用于文档更新、TypeDoc输出生成和文档验证场景。关键词:文档生成、TypeDoc、前端开发、fe-tools、文档验证、代码同步、API文档、开发工具。
packages/*/src/index.ts中的导出API正确。npm run docs以生成TypeDoc输出。