跳转到主要内容
Agent 建议适用于 自定义方案。若要为你的组织启用建议功能,请联系我们的销售团队
你可以让 agent 基于两个来源提出文档更新建议。
  • 拉取请求中的变更(pull request changes):监控选定 Git 仓库中那些需要更新文档的代码变更。
  • AI 助手会话(assistant conversations):分析用户在你的文档站点向 AI 助手提出的问题,以识别内容缺口。
当 agent 识别到潜在的文档更新时,它会在你的控制台中创建一条建议,并附上相应的 context,方便你据此创建拉取请求(PR;亦称“合并请求”/Merge Request)。 使用这些建议,在新功能发布时主动保持文档最新,或用来解决常见的用户问题。

前提条件

在使用建议功能之前,你必须在你的组织中安装 Mintlify GitHub App。该应用必须能够访问你的文档存储库,以及至少一个其代码变更需要对应文档更新的其他存储库。

配置建议

在 agent 的设置中配置 agent 要监控哪些存储库,以及你如何接收通知。设置页面会显示 agent 正在监控的所有 GitHub 组织和存储库。 要打开 agent 设置:
  1. 在控制台中点击 Ask agent 按钮,打开 agent 面板。
  2. 点击 Settings 按钮。
    亮色模式下的设置按钮。

监控存储库

agent 会监控你启用监控的每个存储库的默认分支(通常是 main)。在受监控的存储库中,一个名为 Mintlify Autopilot 的 GitHub 检查会在拉取请求上运行,以分析其是否可能需要更新文档。当你合并了一个需要更新文档的拉取请求时,agent 会在你的控制台中创建一条建议。
当你首次为某个存储库启用监控时,agent 会为过去七天内合并的拉取请求生成建议。仅当该存储库尚无任何建议时,才会进行此回填操作。启用监控后,你可能会立即看到多条建议出现。
如果你禁用监控,agent 会立刻停止监控该存储库。该存储库的所有现有建议会继续保留在你的控制台中,直到你将其关闭。

会话洞察

启用会话洞察后,系统会根据用户向 AI 助手提出的常见问题生成建议。 启用后,智能体会定期分析与 AI 助手的会话,在识别出表明文档缺失或不清晰的提问模式时创建相应的建议。

通知

智能体的建议始终会显示在控制台中。你可以配置通知,在智能体创建新建议时通过电子邮件或 Slack 私信接收通知。
如果你没有收到建议相关的电子邮件通知,请检查垃圾邮件文件夹,并将邮箱地址 notifications@mintlify.com 添加到你的安全发件人列表中。

审核建议

agent 会在你的控制台中创建建议。每条建议都会显示触发该建议的拉取请求(PR;亦称“合并请求”/Merge Request)或 AI 助手会话的主题、建议的创建时间,以及建议的文档更新内容。 控制台中的 Ask agent 按钮会显示等待你审核的建议数量。
Ask agent 按钮在浅色模式下显示四条建议。

创建拉取请求(PR)

将建议添加为 agent 的上下文信息,以便创建拉取请求(PR)。
  1. 在控制台中点击 Ask agent 按钮以打开 agent 面板。
  2. 点击 Add to chat
  3. 将提示词提交给 agent 以打开一个拉取请求(PR)。

忽略建议

如果某条建议不需要更新文档,或者你已经处理了相关更改,可以将其忽略,以便将其从控制台中移除。
  1. 在控制台中点击 Ask agent 按钮,打开 agent 面板。
  2. 点击任意你想忽略的建议旁边的 Dismiss 按钮。
该建议会立即从控制台中移除。你无法找回已忽略的建议。