Agent 建议

监控 Git 仓库变更，并接收文档更新建议。

Agent 建议适用于 自定义方案。若要为你的组织启用建议功能，请联系我们的销售团队。

你可以让 agent 监控你选定的 Git 仓库并提出文档更新建议。当 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 会立刻停止监控该存储库。该存储库的所有现有建议会继续保留在你的控制台中，直到你将其关闭。

​

通知

智能体的建议始终会显示在控制台中。你可以配置通知，在智能体创建新建议时通过电子邮件或 Slack 私信接收通知。

如果你没有收到建议相关的电子邮件通知，请检查垃圾邮件文件夹，并将邮箱地址 [e-mail] 添加到你的安全发件人列表中。

​

审核建议

当 agent 在你监控的存储库中检测到面向用户的更改时，它会创建建议，并将其显示在你的控制台中。每条建议都会显示拉取请求（PR；亦称“合并请求”/Merge Request）的标题、存储库名称、建议的创建时间，以及建议的文档更新内容。

控制台中的 Ask agent 按钮会显示等待你审核的建议数量。

​

创建拉取请求（PR）

将建议添加为 agent 的上下文信息，以便创建拉取请求（PR）。

1. 在控制台中点击 Ask agent 按钮以打开 agent 面板。
2. 点击 Add to chat。
3. 将提示词提交给 agent 以打开一个拉取请求（PR）。

​

忽略建议

如果某条建议不需要更新文档，或者你已经处理了相关更改，可以将其忽略，以便将其从控制台中移除。

1. 在控制台中点击 Ask agent 按钮，打开 agent 面板。
2. 点击任意你想忽略的建议旁边的 Dismiss 按钮。

该建议会立即从控制台中移除。你无法找回已忽略的建议。