跳转到主要内容
Autopilot 会监控你选定的 Git 仓库,并提出文档更新建议。Autopilot 会标记你应用中可能影响用户的更改,并为代理准备上下文,以起草用于更新文档的拉取请求(PR;亦称“合并请求”/Merge Request)。
使用 Autopilot,在新功能或更新发布时主动保持文档始终最新。
在使用 autopilot 之前,必须先在你的组织中安装 Mintlify GitHub 应用。该应用必须能够访问你的文档存储库,以及至少一个其他存储库,其中的代码更改需要同步更新文档。
在控制台中前往 autopilot 页面,以查看建议并配置存储库监控。autopilot 页面会显示等待你审核的建议,并提供访问配置设置的入口。
在 autopilot 页面点击 Configuration 按钮来配置 autopilot 设置。
配置页面会显示你已安装 Mintlify GitHub 应用的所有 GitHub 组织,以及 autopilot 正在监控的代码仓库。
在将 Mintlify GitHub 应用安装到你的组织后,你可以选择要监控的存储库。
-
前往 autopilot 设置页面。
-
找到包含你想要监控的存储库的 GitHub 组织。
-
点击组织名称旁边的齿轮图标。
-
打开每个你想监控的存储库旁边的开关。
-
使用搜索栏按名称筛选存储库。
-
点击 Enable all 或 Disable all,即可快速配置所有存储库。
Autopilot 会监控每个存储库的默认 branch(通常为 main)。当有拉取请求(PR;亦称“合并请求”/Merge Request)合并到该 branch 时,Autopilot 会分析更改并生成建议。
-
前往 Autopilot 设置页面。
-
找到要停止监控的存储库所在的 GitHub 组织。
-
点击组织名称旁边的齿轮图标。
-
关闭要停止监控的存储库旁边的开关。
-
使用搜索栏按名称筛选存储库。
Autopilot 会立即停止监控该存储库。该存储库已有的任何建议会保留在你的控制台中,直到你将其关闭或忽略。
当 Autopilot 在你监控的存储库中检测到面向用户的更改时,它会创建建议并显示在你的控制台中。每条建议都会展示拉取请求(PR;亦称“合并请求”/Merge Request)的标题、存储库名称、说明为何该更改可能需要更新文档的摘要,以及建议创建时间。
当你应用某条建议时,autopilot 会打开包含该拉取请求(PR;亦称“合并请求”/Merge Request)相关上下文信息的 agent 面板。agent 会接收该拉取请求的 URL 以及关于变更文件的摘要。
- 在控制台中前往 autopilot 页面。
- 点击 Apply suggestion。
- 使用 agent 界面来进一步完善建议的文档更新,或创建一个拉取请求。
如果某条建议不需要更新文档,或者你已经处理了对应的更改,可以将其忽略,将其从控制台中移除。
- 在控制台中进入 autopilot 页面。
- 点击 Dismiss。
该建议会立即从你的可见列表中移除。你无法恢复已忽略的建议。