Jamdesk Documentation logo

使用 AI 修复

在 Jamdesk 构建仪表板中审查并应用 AI 建议的修复,修复断开的链接和缺失的页面描述,并为您提交到 GitHub。

Jamdesk 可以修复构建报告中的许多断开链接和缺失的页面描述。Fix with AI 按钮会读取这些构建警告,并为每一项提出修改建议。它会将您批准的修复提交到您连接的 GitHub 仓库。该提交会启动一次新的构建。

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

jamdesk fix CLI 命令在您的终端中执行相同的操作。它会写入您的工作副本,提交则由您自行完成。

可修复的问题

Fix with AI 可修复三类构建警告:

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

只有在能够确定地解析目标时,它才会提出修改。模棱两可的问题会单独列出,由您手动修复。

Fix with AI 每个项目在 24 小时内最多发出 1,000 次 AI 请求。未更改页面的结果会被复用,不计入此限制。

可修复数量与警告数量并不相同。一次构建可能显示五条警告,而 Fix with AI 只能修复其中三条。另外两条没有明确的修复方案。

选择处理方式

AI Fixes 设置决定 Jamdesk 如何处理可修复的警告。要更改它,请点击侧边栏中的 Settings,然后在 General 下找到 AI Fixes 卡片。

模式发生的情况
OffJamdesk 不扫描构建。Fix with AI 按钮会被隐藏。
Review firstJamdesk 提出修复建议。您在弹窗中审查并应用。这是默认设置。
Auto-fixJamdesk 在每次构建后提交修复。您可以撤销每一次运行。

Auto-fix 的工作方式

Auto-fix 应用与弹窗中相同的修复,包括 AI 撰写的描述。它会跳过您已忽略的内容。保存该设置后,从下一次构建开始生效。

构建完成后,Jamdesk 会将修复提交到项目的构建分支。提交信息为 docs: auto-fix 3 issues (via Jamdesk),作者为 Jamdesk。构建历史中会显示 Auto-fixed 徽章。对于没有 GitHub 的文档,Jamdesk 会将修复保存到您的文档中。

Jamdesk 会提交到您的分支。推送前请先拉取。每次 auto-fix 提交还会运行您仓库在该分支上配置的任何 CI。

每次运行的预期行为:

  • Jamdesk 不会对其自身提交的构建执行自动修复。如果该构建仍有可修复的警告,它会显示 Needs review,您需要在弹窗中应用这些修复。
  • 每项修复只应用一次。如果您撤销了某项修复,Jamdesk 不会再次应用它,因此您的撤销会保持有效。重新出现的修复会显示在 Needs review 下。
  • 自上次运行以来警告未发生变化的构建会被跳过。
  • 当构建分支受保护或 Jamdesk GitHub App 失去写入权限时,Auto-fix 会暂停。卡片会显示 Paused。解决原因后,再次保存 Auto-fix。
  • 每日 AI 限制与弹窗相同。当项目达到限制时,运行会跳过部分修复并予以说明。
  • 新的描述会改变页面,因此下一次翻译运行会重新翻译该页面。

前提条件

  • 项目已连接 GitHub 仓库。
  • Jamdesk GitHub App 具有提交修复的写入权限。缺少权限时,弹窗会显示一个指向 GitHub 的 Grant access 链接。
  • 一次已完成的构建,且其中包含断开链接或缺失描述的警告。

查找横幅

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

A build history panel with a highlighted banner reading 3 issues on this build can be fixed with AI next to a Fix with AI button. The newest build row shows a successful status with a warning badge of 5.

横幅仅出现在您最新完成的构建上。修复始终针对您文档的当前状态应用。

查看并应用修复

1
打开预览

点击 Fix with AI。弹窗打开。AI 代理需要几秒钟来审查您的文档并生成修复计划。

2
阅读每项建议的更改

修复按类型分组。Broken links 显示每个重写的锚点。Missing descriptions 显示每个页面的建议摘要。Missing titles 显示建议的标题。清除任意复选框即可本次跳过该项。使用忽略按钮永久屏蔽某条建议。没有明确修复方案的问题会列在 Can't be fixed automatically 下,供您手动修复。

The Fix with AI modal. A Broken links section lists three checked fixes, each showing the old anchor struck through and the corrected anchor. A Can't be fixed automatically section lists two issues to fix by hand, above Cancel and Apply 3 fixes buttons.
3
应用

点击 Apply fixes。Jamdesk 会将所选更改以 docs: apply AI-suggested fixes (via Jamdesk) 为提交信息,提交到您连接的分支,并启动一次新构建。

4
确认重新构建

在构建历史中查看新构建。上线后,已修复的警告会消失。剩余的要么是 Fix with AI 无法解决的警告,要么是最新内容引入的新问题。

应用修复会在您的仓库中写入一次真实的提交。您可以像对待其他提交一样在 GitHub 上审查或撤销它。

某些问题无法修复时

弹窗会将没有明确修复方案的警告列在单独的标题下,并保持不变。常见原因包括:

  • 断开的链接,其目标页面或标题在任何地方都不存在。
  • 导航条目没有对应的源文件。
  • AI 无法为某个页面生成描述。

这些需要手动编辑。请在编辑器或您的代码编辑器中打开该页面,修正链接或添加描述,然后推送以重新构建。

忽略建议

有些警告不值得处理:例如您有意设置的断开链接,或无需描述的占位页面。取消勾选某项修复只会跳过一次。忽略则会将其从计数中移除,直到您恢复它。

弹窗中的每一行都有忽略按钮,无论是否可修复。点击后,该项会移到底部折叠的 Ignored 区域。关闭弹窗后,项目主页上的横幅数量会相应减少。当前构建及之后的每次构建中,相应警告都会从构建历史中消失。Ignore all 会对所有仍列出的项执行同样的操作。

忽略的行为方式:

  • 共享且持久:忽略设置适用于整个项目。所有成员看到的列表相同。它会跨构建保留。Jamdesk 通过内容而非行号匹配每条警告。编辑页面的其他部分不会使已忽略的项重新出现。
  • 恢复:展开 Ignored 区域,点击任意项上的 Restore。忽略某次构建中的全部内容会隐藏横幅。随后,构建历史下方一个小的“N ignored recommendations”链接会重新打开弹窗。
  • 变化的警告会重新出现:当潜在问题发生变化时(例如断开的链接现在指向了其他位置),已忽略的项会作为新建议重新出现。

撤销 auto-fix

每次 auto-fix 运行都有一个 Undo 按钮。在构建历史中打开该构建,找到 Auto-fix 区域。它列出了 Jamdesk 所做的更改,并链接到该提交。点击 Undo,然后点击 Undo auto-fix 确认。

Jamdesk 会将文件的先前版本以 docs: undo Jamdesk auto-fix (via Jamdesk) 为提交信息提交到您的分支。如果某个文件在 auto-fix 之后又被修改,Jamdesk 会跳过它并将其列出。这些文件需要您手动撤销。

被撤销的修复会被忽略。它们的警告会被隐藏,Jamdesk 也不会再次应用它们。如需恢复,请打开 Fix with AI,在 Ignored 下将其恢复。

将修复交给您的 AI 代理

您可以让 Claude Code 等编码代理在您的仓库中进行编辑。在 Fix with AI 弹窗中,点击 Copy for your AI agent。Jamdesk 会复制一段纯文本提示,其中列出每条建议修复及其文件和行号,以及需要手动修复的问题。已忽略的项会被排除。将提示粘贴到您的代理中即可。

在终端中,jamdesk fix --json 会以 JSON 格式为代理提供相同的列表。参见与 AI 代理一起使用。

Fix with AI 与 CLI 对比

仪表板和 CLI 都能修复断开链接的锚点。它们的区别在于运行位置以及更改的落地方式。

Fix with AI(仪表板)jamdesk fix(CLI)
运行位置在仪表板中,针对某次构建在您的终端中,针对本地文件
修复内容断开的链接、缺失的描述和缺失的标题断开链接的锚点,以及借助 AI 补全缺失的描述
提交为您提交到您的分支写入本地文件;由您提交
触发方式在构建横幅上点击一次jamdesk fix

当您希望无需离开 Jamdesk 即可快速修复时,使用仪表板流程。当您希望先在工作副本中查看更改时(例如将其与其他编辑打包在一起),使用 CLI。

将 AI Fixes 设为 Off 会停止仪表板扫描。jamdesk fix 仍可在您的计算机上运行。要从终端更改该设置,请使用 jamdesk ai-fix 加上 off、review 或 auto:

jamdesk ai-fix auto

下一步

监控构建

跟踪构建状态,阅读警告和建议

修复断开的链接(CLI)

从终端自动修复断开的链接