Jamdesk Documentation logo

使用 AI 修复

从 Jamdesk 构建仪表板中查看并应用 AI 为失效链接和缺少页面描述建议的修复,并由系统提交到 GitHub。

当构建因存在失效链接或页面缺少描述而完成时,Jamdesk 可以为你修复其中许多问题。Fix with AI 按钮会读取这些构建警告,为每个警告提出具体编辑建议,并将你批准的修复提交到已连接的 GitHub 仓库,从而启动新的构建。本页适用于维护 Jamdesk 站点、希望清除构建警告而无需手动编辑 MDX 的用户。

屏幕截图显示的是英文界面。

如需在本地通过终端使用相同功能,请参阅 jamdesk fix CLI command。仪表板流程会代你提交更改;CLI 会写入你的工作副本,并将提交操作留给你。

可修复的问题

Fix with AI 适用于三类构建警告:

  • 失效的内部链接。 链接片段指向目标页面中已不存在的标题,例如拼写错误(#instalation#installation),或标题已重命名的翻译页面。
  • 缺少页面描述。 页面的 frontmatter 中没有 description。Jamdesk 会根据页面内容为你生成简短摘要,供你审核。
  • 缺少页面标题。 没有标题的页面会获得一个根据页面内容生成的建议标题,供你审核。

只有在能够有把握地解析目标时,系统才会提出更改。任何存在歧义的内容都会保持不变,并单独列出,供你手动修复。

可修复数量不等于警告数量。一次构建可能显示五个警告,但 Fix with AI 只提供其中三个的修复,因为另外两个没有明确的修复方案。横幅始终反映实际可修复的问题数量。

前提条件

  • 项目已连接 GitHub 仓库
  • Jamdesk GitHub App 具有写入权限,以便提交修复。如果缺少权限,模态框会显示 Grant access 链接,将你带到 GitHub 添加权限。
  • 已完成的构建中包含失效链接或缺少描述的警告。

查找横幅

打开项目,在项目主页滚动到 Build History。当最新构建存在可修复问题时,构建列表上方会显示横幅,其中包含问题数量和 Fix with AI 按钮。

构建历史面板,其中突出显示了一个横幅,内容为此构建中的 3 个问题可使用 AI 修复,旁边是 Fix with AI 按钮。最新构建行显示成功状态,并带有显示 5 个警告的徽章。

横幅只会显示在最新的已完成构建中。历史记录中的旧构建不会显示横幅,因为修复始终应用于文档的当前状态。

查看并应用修复

1
打开预览

点击 Fix with AI。模态框会打开,AI 代理会检查你的文档并生成修复计划。此过程需要几秒钟。

2
阅读每项建议的更改

修复会按类型分组。Broken links 会显示每个重写后的锚点,Missing descriptions 会显示每个页面的建议摘要,Missing titles 会显示建议的标题。取消选中你这次不想应用的修复,或使用忽略按钮永久隐藏建议。没有明确修复方案的问题会显示在 Can't be fixed automatically 下方,留给你手动处理。

Fix with AI 模态框。Broken links 部分列出了 3 个已选中的修复,每个修复都显示了带删除线的旧锚点和修正后的锚点。Can't be fixed automatically 部分列出了 2 个需要手动修复的问题,下方是 Cancel 和 Apply 3 fixes 按钮。
3
应用

点击 Apply fixes。Jamdesk 会将选中的更改提交到已连接的分支,提交消息为 docs: apply AI-suggested fixes (via Jamdesk),然后启动新的构建。

4
确认重新构建

Build History 中查看新的构建。上线后,已修复的警告会消失。剩余内容要么是 Fix with AI 无法解析的警告,要么是最新内容产生的新问题。

应用修复会在你的仓库中创建真实提交,因此更改会记录在 Git 历史中,你可以像处理其他提交一样在 GitHub 上查看或还原它。

某些问题无法修复时

如果警告没有明确的修复方案,模态框会在单独的标题下列出该警告,并保持不变。常见原因包括:

  • 失效链接的目标页面或标题在任何地方都不存在,因此没有可指向的目标。
  • 没有匹配源文件的导航条目。
  • 代理无法自动生成描述的页面。

这些问题需要手动编辑。打开 编辑器 或你的代码编辑器,修正链接或添加描述,然后推送以重新构建。

忽略建议

有些警告不值得处理:例如你有意破坏的链接,或不需要描述的占位页面。取消选中修复只会跳过这一次。忽略操作会将其从计数中移除,直到你另行恢复。

模态框中的每一行,无论是否可修复,都有忽略按钮。点击该按钮后,项目会移动到底部折叠的 Ignored 部分。关闭模态框后,项目主页上的横幅计数会相应减少,匹配的警告也会从当前构建及之后的每个构建的 Build History 中消失。Ignore all 会对仍列出的所有项目执行相同操作。

忽略的行为如下:

  • 共享且持久。 忽略设置适用于整个项目,因此所有成员都会看到相同列表,并且设置会跨构建保留。Jamdesk 会根据警告内容而不是行号匹配每个警告,因此编辑页面的其他部分不会使已忽略项目重新出现。
  • 恢复。 展开 Ignored 部分,然后点击任意项目上的 Restore。如果你忽略了某次构建中的所有项目,横幅会消失,Build History 下方的小型“N ignored recommendations”链接可以重新打开模态框。
  • 已更改的警告会重新出现。 如果底层问题发生变化,例如失效链接现在指向了其他位置,它就不再匹配已忽略条目,并会作为新的建议重新显示。

Fix with AI 与 CLI 对比

这两种工具都可以修复失效链接锚点,但运行位置和更改落地方式不同。

Fix with AI (dashboard)jamdesk fix (CLI)
运行位置在仪表板的构建中在终端中,针对本地文件
修复内容失效链接和缺少描述失效链接锚点
提交代你提交到分支写入本地文件,由你提交
触发方式点击构建横幅中的按钮jamdesk fix

如果你希望快速修复而不离开 Jamdesk,请使用仪表板流程。如果你希望先将更改放入工作副本中,例如与其他编辑一起提交,请使用 CLI。

下一步

监控构建

跟踪构建状态并查看警告和建议

修复失效链接(CLI)

从终端自动修复失效链接