已关闭
ops-ras 英文文档导航链接语言错配 #50
KaranocaVe创建于 9月26日关闭于 18 天前
9月26日 关联了pull request:修正英文文档导航链接指向中文页面
9月26日 修改了issue 的描述
yue-ma
9月27日 评论:
9月27日 评论:
/assign @KaranocaVe


9月27日 将 KaranocaVe 设为负责人
18 天前 关闭了 issue
18 天前 添加了label:resolved
KaranocaVe
8 天前 评论:
8 天前 评论:
@yue-ma 您好,这个 Issue 对应的修复已经合入:https://gitcode.com/cann/ops-ras/merge_requests/124
开发者计划反馈,Issue 需要有 Accepted 标签才能计入积分,仅关闭或标记 resolved 还不够。目前这条 Issue 尚未标记 Accepted,麻烦您结合问题和已合入的修复复核一下;确认符合受理条件后,帮忙补上 Accepted 标签。
感谢您的支持!


ops-ras 英文文档导航链接语言错配
结论
固定公开源码
cann/ops-ras@e43ac41176f9c57fd0d38db8f53354016b90f8b2的英文文档入口有 18 个相对链接指向中文 README 或docs/zh/页面。对应英文页面已经在同一提交的README_en.md、docs/QUICKSTART_en.md和docs/en/中存在。链接目标大多可以打开,但英文用户会被带到中文内容,两个 README 锚点还使用了中文标题。问题不是死链:固定提交的文件树同时包含中文和英文目标。问题是英文导航没有遵守仓库已经建立的中英文页面配对,导致英文入口的语言上下文被切换。
固定源码与精确位置
仓库:
cann/ops-ras源码提交:
e43ac41176f9c57fd0d38db8f53354016b90f8b2README_en.md:34docs/zh/install/quick_install.mddocs/en/install/quick_install.mdREADME_en.md:49docs/QUICKSTART.mddocs/QUICKSTART_en.mdREADME_en.md:50docs/README.mddocs/README_en.mdREADME_en.md:54docs/zh/install/dir_structure.mddocs/en/install/dir_structure.mddocs/README_en.md:44zh/install/compile.mden/install/compile.mddocs/README_en.md:45zh/invocation/quick_op_invocation.mden/invocation/quick_op_invocation.mddocs/README_en.md:46zh/develop/aicore_develop_guide.mden/develop/aicore_develop_guide.mddocs/README_en.md:48zh/debug/op_debug_prof.mden/debug/op_debug_prof.mddocs/README_en.md:54zh/op_list.mden/op_list.mddocs/README_en.md:55zh/op_api_list.mden/op_api_list.mddocs/README_en.md:61zh/debug/cann_sim.mden/debug/cann_sim.mddocs/README_en.md:71zh/context/basic_concept.mden/context/basic_concept.mddocs/README_en.md:72zh/install/build.mden/install/build.mddocs/QUICKSTART_en.md:7../README.md../README_en.mddocs/QUICKSTART_en.md:275../README.md#学习教程../README_en.md#learning-tutorialsdocs/QUICKSTART_en.md:275../README.md#相关信息../README_en.md#related-informationdocs/en/invocation/quick_op_invocation.md:6../../zh/op_list.md../../en/op_list.mddocs/en/invocation/quick_op_invocation.md:6../../zh/op_api_list.md../../en/op_api_list.md事实证据
README_en.md、docs/QUICKSTART_en.md、docs/README_en.md,以及docs/en/{context,debug,develop,install,invocation}下对应页面。Learning Tutorials、Related Information标题;固定提交对应的 GitCode 页面渲染出learning-tutorials、related-information两个锚点。中文锚点学习教程、相关信息不属于英文页面标题。e6f47ca7ed19ad09f08ffc2a9fe99b8fa123412b成批加入,包含上述英文入口和详细页面;这证明docs/en/是有意提供的英文文档树,而不是缺少英文替代页面。用户影响
英文用户从项目英文 README、英文文档目录、英文快速开始或英文算子调用指南继续导航时,会进入中文页面,无法保持预期的英文阅读路径;快速开始结尾的两个链接还无法按英文标题定位到对应章节。
最小修复边界
fix.patch仅把上述 18 个相对目标改为已有英文页面,并将两个中文 README 锚点改为英文锚点。不改文档内容、源码、构建脚本或测试。docs/README_en.md:47指向的examples/fast_kernel_launch_example/README.md是中英双语页面且没有独立英文副本,因此不将其作为错配修复;根 README 的中英文切换入口和外部官方中文链接也不在本案范围内。去重
.run安装命令缺少--full,文件范围和根因均不同。#14与 PR!81、!82只新增根 README 的中英文切换入口,没有修正英文文档内部导航。#21、#24、#41、#42、#44、#45及 PR!85、!109、!112处理的是不存在的文件名、图片路径或锚点失效;本案的 18 个目标文件均存在,根因是语言目录选择错误。#8与 PR!76负责补齐英文文档集合,未覆盖补齐后英文入口仍指向中文页面的问题。Validation
验证记录
在固定提交
e43ac41176f9c57fd0d38db8f53354016b90f8b2上,14 个唯一英文目标文件均存在,英文 README 对应章节锚点为learning-tutorials和related-information。基线扫描发现 18 个指向中文页面或中文锚点的链接。应用补丁后,同一规则发现 0 个错配;
git apply --check --whitespace=error-all、git diff --check和git apply --reverse --check --whitespace=error-all均通过。补丁只改动 4 个英文 Markdown 文件,不涉及源码、构建脚本或运行时行为。本案是文档链接与文件树的静态检查,不声称进行了 NPU 或 CANN 运行验证。
关联 PR: https://gitcode.com/cann/ops-ras/merge_requests/124