在更改进入已发布的站点之前先进行预览,然后无需离开编辑器即可审阅并合并 pull request。
实时预览会在你编辑时渲染站点,无需构建步骤。点击顶部栏中的 实时预览按钮。
若要编辑站点设置并查看其对内容的影响,请点击预览工具栏中的 Site settings ,然后选择一个配置分区。如果你启用了 Open live preview in new tab ,则无法使用该菜单。
若要在预览旁边打开智能体 ,请点击预览工具栏中的 Ask agent 。只有 editors 和 admins 才能在实时预览中使用智能体。
实时预览适用于公开站点,以及受 Mintlify 认证保护的站点。
当你从 feature branch 打开 pull request 时,Mintlify 会构建一个预览部署:一个临时 URL,其中你的更改会完全按照发布后的样子呈现。每当你向该分支保存新的更改,预览都会重新构建。
若要查找并共享该 URL,请点击工具栏中的 Publish 。URL 格式为 organization-branch-name.mintlify.site。
预览 URL 默认可公开访问。若要将访问权限限制为你的 Mintlify 组织成员,请在仪表板的 Add-ons 页面上启用预览认证。
若要把同事引导到某个分支上的特定页面,请从浏览器地址栏复制 URL。任何有权访问你的 Mintlify 组织的人都可以在自己的编辑器会话中打开它。
例如:https://app.mintlify.com/acme/docs/editor/main/~/guides/quickstart.mdx
当前分支存在打开的 pull request 时,发布菜单会显示一个审阅面板,其中包含:
pull request 的标题和描述
源分支和目标分支
已更改文件的数量
deployment branch 上的审批要求
当前的审阅状态
审阅者批准后,点击 Merge and publish 即可在编辑器中完成合并和部署。合并后,编辑器会把你切换回 deployment branch。
对于 GitHub 仓库,审阅者无需离开编辑器即可批准打开的 pull request。如果你的账户有审阅权限,审阅面板中会出现 Approve pull request 按钮。状态会更新为 Approved ,并且 Merge and publish 变为可用。
如果你使用 GitLab 或 Bitbucket,请在对应的 Git 提供方中打开该 pull request 进行批准。
在发布菜单中点击任意已更改的文件,即可在 diff 视图中将其与已发布版本进行比较。可视化模式显示可视化 diff,source 模式显示文本 diff。无法显示 diff 的文件(例如图片或已删除的文件)会出现在列表中,但无法点击。
出现在分支 diff 中的隐藏页面 也可以从发布菜单中打开,即使它们并未出现在站点导航中。
如果你的组织要求使用 pull request,你可以在发布时输入标题和描述。如果其中任一项留空,编辑器会生成一个,列出你创建、更新、移动或删除的文件。若要控制其撰写方式,请设置 PR 说明 。
如果你的分支存在未解决的评论线程,Mintlify 会把这些线程的摘要添加到 pull request 描述中。请参阅协作 。
当自动化 打开 pull request 时,你可以在该自动化的分支上打开编辑器:
在仪表板的 Automation Runs 页面中,点击已完成运行上的 Open in editor 。
在 Slack 通知中,点击 View changes 链接。
这两种入口都会在自动化所在的分支上打开编辑器,并在发布菜单中预先选中被修改的页面,让你无需离开编辑器即可审阅 diff 并进行合并或请求修改。智能体 会在旁边打开,并带有该自动化所做工作的上下文。