Skip to main content
Agent 建议适用于 自定义方案。若要为你的组织启用建议功能，请联系我们的销售团队。
你可以让 agent 监控你选定的 Git 仓库并提出文档更新建议。当 agent 识别到你的应用中可能出现的面向用户的更改时，它会为你准备好相应的 context，方便你一键创建拉取请求（PR；亦称“合并请求”/Merge Request）来更新文档。 在新功能或更新发布时，使用建议功能主动保持文档的最新状态。

​
前提条件

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

​
配置建议

在智能助手设置中配置要为哪些仓库提供建议。 配置页面会显示你已安装 Mintlify GitHub 应用的所有 GitHub 组织，以及智能助手当前正在监控的仓库。

​
选择要监控的存储库

在你的组织中安装 Mintlify GitHub 应用后，选择要监控的存储库。
  1. 在控制台中点击 Ask agent 按钮，打开 agent 面板。
  2. 点击 Settings 按钮。
    亮色模式下的设置按钮。
  3. 在 Monitor Repositories 部分，点击包含你想监控的存储库的组织名称。
  4. 打开每个你想监控的存储库旁边的开关，或者点击 Enable all 来监控该组织中的所有存储库。
agent 会监控每个存储库的默认分支（通常是 main）。当有拉取请求合并到该分支时，agent 会分析更改并生成建议。

​
停止监控存储库

  1. 在控制台中点击 Ask agent 按钮以打开 agent 面板。
  2. 点击 Settings 按钮。
    浅色模式下的设置按钮。
  3. 在 Monitor Repositories 部分，点击包含你想停止监控的存储库的组织名称。
  4. 将你想停止监控的存储库旁边的开关关闭，或者点击 Disable all 来停止监控该组织中的所有存储库。
agent 会立即停止监控该存储库。该存储库的任何现有建议会保留在你的控制台中，直到你将其关闭为止。

​
审核建议

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

​
创建拉取请求（PR）

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

​
忽略建议

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