SuperAPI AI 工具集

nat-path-checks

写作与研究

查看项目

更新于 10-16 07:24

技能介绍

用途:当 NeMo Agent Toolkit 的 CI 报告 ci/scripts/path_checks.py 路径检查失败时使用,特别是复制来的 CI 输出中出现“Failed path checks: docs/example.md:40:10 -> data/test1”这类条目时。

工作流程:先打开每个被报告文件的确切行再修改;按含义而非仅按形状对报告中的标记分类;应用能保留含义的最小修改;对改动文件重新运行路径检查与 Markdown 链接检查。

处理决策:若斜杠文本只是散文简写而非路径,改写为文字,不要仅为通过 CI 而藏进代码(如 linux/amd64 改写为 linux 或 amd64,pass/fail 改写为 pass 或 fail);若是两个字段名或概念,分别命名(question/answer 改写为 question 和 answer);若是精确的 CLI、协议、API、配置或方法字面量,用行内代码包裹(tools/list);散文中的占位路径同样用行内代码(path/to/workflow.yml);列表或片段中的占位路径用围栏代码块;真实仓库相对路径应改为相对当前文件的正确路径并按需加链接;预期生成输出路径用行内代码或围栏代码块。跨多文档的重复误报优先做局部措辞或转义修复,仅在确认检查器局限后再通过 ALLOWLISTED_WORDS、IGNORED_PATHS 或 ALLOWLISTED_FILE_PATH_PAIRS 添加允许列表。

关键区分:不需要精确复制的斜杠文本改写为散文;需要精确复制的放进 Markdown 代码;指向仓库真实文件的应修正目标而非转义。不要用不同措辞替换有意义的相对路径,除非该路径本就非字面含义。

验证:编辑后从仓库根目录运行 uv run ci/scripts/path_checks.sh 与 uv run pre-commit run markdown-link-check --files path/to/changed.md。若复制的 CI 日志中有大量失败,逐文件修复并重新运行检查,再套用同一模式。