1自动生成 API 参考文档
- 1在项目中安装并配置 Mintlify Writer,连接您的代码仓库或 API 定义文件
- 2在构建过程中自动扫描代码注释和 API 端点,生成结构化的参考文档
- 3将生成的文档部署到 Mintlify 托管平台,并实时更新
2为现有代码库快速补充文档
- 1在代码编辑器中安装 Mintlify Writer 扩展
- 2选中需要文档化的函数或类,右键选择“生成文档”
- 3审查并编辑生成的草稿,然后合并到项目文档中
3维护文档与代码同步更新
- 1在 CI/CD 流水线中集成 Mintlify Writer
- 2每次代码提交后自动触发文档重新生成
- 3通过 Pull Request 审查文档变更,确保与代码同步