跳转到主要内容
将你的 Linear 工作区连接到 agent,即可从 Linear 中进行文档更新。当你在 Linear 评论中提及 Mintlify agent 或将 issue 分配给它时,agent 会从该 issue 中获取上下文,并在你的文档仓库中创建一个包含建议更改的拉取请求 (PR;亦称”合并请求”/Merge Request) 。

连接你的 Linear 工作区

  1. 在控制台中进入 Agent 页面。
  2. 在 “Agent settings” 部分,点击 Install Linear app
应用设置区域,包含 Slack 和 Linear 安装按钮。
  1. 按照 Linear 的提示授权 Mintlify 应用访问你的工作区。

在 Linear 中使用 agent

连接完成后,在 Linear issue 中提及 @mintlify 或将 issue 分配给 Mintlify 即可触发文档更新。agent 会利用 issue 的标题、描述和评论线程作为上下文,然后在你的文档仓库中创建一个拉取请求 (PR;亦称”合并请求”/Merge Request) 。 在 Linear 中使用 agent 可以:
  • 根据功能 issue 更新文档:当某个功能发布时,在 issue 中提及 agent 以起草或更新相关文档。
  • 处理文档反馈:在 Linear 中创建文档改进 issue,并提及 agent 来执行相应更改。
  • 生成发布说明:在与发布相关的 issue 中提及 agent,根据 issue 详情起草变更日志条目。
  • 修复报告的问题:当有人在 Linear 中报告文档问题时,提及 agent 来解决它。

最佳实践

  • 在 issue 中提供充足的上下文:你在 issue 中提供的上下文越多,生成的拉取请求质量就越高。
  • 审查拉取请求:在合并之前,始终审查 agent 创建的拉取请求。
  • 在评论中迭代:在同一 issue 线程中回复以优化 agent 的输出,就像在 Slack 中一样。