使用 AI 修复
从 Jamdesk 构建仪表板审查并应用 AI 为断链和缺少页面描述建议的修复,并自动提交到 GitHub。
当构建因存在断链或页面缺少描述而完成时,Jamdesk 可以为你修复其中许多问题。Fix with AI 按钮会读取这些构建警告,为每个警告提出具体编辑建议,并将你批准的修复提交到已连接的 GitHub 仓库,从而启动一次全新的构建。本页适用于维护 Jamdesk 网站、希望清除构建警告而不想手动编辑 MDX 的用户。
屏幕截图显示的是英文界面。
如果你想在本地通过终端使用相同功能,请参阅 jamdesk fix CLI 命令。下面介绍的仪表板流程会替你提交更改;CLI 会写入工作副本,提交操作则由你完成。
可修复的问题
Fix with AI 适用于三类构建警告:
- 断开的内部链接。 链接片段指向目标页面中已不存在的标题,例如拼写错误(
#instalation→#installation),或标题已重命名的翻译页面。 - 缺少页面描述。 页面前置元数据中没有
description。Jamdesk 会根据页面内容为你写入一段简短摘要,供你审核。 - 缺少页面标题。 没有标题的页面会获得一个根据页面内容生成的建议标题,供你审核。
只有在能够确定目标且置信度足够高时,系统才会提出更改。存在歧义的内容会保持不变,并单独列出,供你手动修复。
可修复问题的数量不等于警告数量。一次构建可能显示五条警告,但 Fix with AI 只提供其中三条的修复,因为另外两条没有明确的修复方式。横幅始终反映实际可修复的问题数量。
前提条件
- 项目已连接的 GitHub 仓库。
- Jamdesk GitHub App 具有写入权限,以便提交修复。如果缺少访问权限,模态框会显示 Grant access 链接,引导你前往 GitHub 添加权限。
- 已完成且包含断链或缺少描述警告的构建。
查找横幅
打开项目,在 Project Home 页面滚动到 Build History。当最新构建存在可修复的问题时,构建列表上方会显示一个横幅,其中包含问题数量和 Fix with AI 按钮。

横幅只会显示在最新的已完成构建上。历史记录中的旧构建不会显示横幅,因为修复始终应用于文档的当前状态。
查看并应用修复
点击 Fix with AI。系统会打开模态框,AI 代理会审核你的文档并生成修复计划。此过程需要几秒钟。
修复按类型分组。Broken links 会显示每个重写后的锚点,Missing descriptions 会显示每个页面的建议摘要,Missing titles 会显示建议的标题。取消选中你暂时不想应用的项目,或使用忽略按钮永久隐藏建议。没有明确修复方式的问题会显示在 Can't be fixed automatically 下方,需由你手动处理。

点击 Apply fixes。Jamdesk 会将选中的更改提交到已连接的分支,提交消息为 docs: apply AI-suggested fixes (via Jamdesk),然后启动新的构建。
在 Build History 中查看新的构建。构建上线后,已修复的警告就会消失。剩余内容可能是 Fix with AI 无法解决的警告,也可能是最新内容引入的新问题。
应用修复会向你的仓库写入真实提交,因此更改会记录在 Git 历史中,你可以像审核或回滚其他提交一样,在 GitHub 上审核或回滚它。
某些问题无法修复时
如果某条警告没有明确的修复方式,模态框会在单独的标题下列出该警告,并保持其不变。常见原因包括:
- 断链的目标页面或标题在任何位置都不存在,因此没有可指向的目标。
- 导航条目没有匹配的源文件。
- 代理无法自动生成页面描述。
这些问题需要手动编辑。打开 editor 或你的代码编辑器,修正链接或添加描述,然后推送以重新构建。
忽略建议
有些警告不值得处理:例如你有意断开的链接,或不需要描述的占位页面。取消选中修复只会跳过这一次。忽略则会将其从计数中移除,直到你恢复为止。
模态框中的每一行,无论是否可修复,都有一个忽略按钮。点击该按钮后,项目会移动到底部折叠的 Ignored 部分。关闭模态框后,Project Home 页面上的横幅计数会相应减少,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。
