Merged
[docs] 修复RFC与自定义算子样例的中英文文档问题 #3153
DiJIa2.0Add on Sep 15
[docs] 修复RFC与自定义算子样例的中英文文档问题 #3153
Merged
Pull Request has been successfully merged by CANN-robot.
（Thank you for DiJIa2.0's contribution.）Sep 15 Associated issue: [Documentation|文档反馈]: 修复RFC和自定义算子样例中英文文档审计问题
atomgit-bot
Sep 15 Comments：
Sep 15 Comments：
变更摘要
本 PR 为纯文档更新（共 17 份 Markdown，净增约 245 行、删 199 行），针对文档审计中确认的中英文信息缺失、错误路径指引与渲染问题，修复 hccl 的 RFC 文档、pre-commit 指导及 P2P/AllGather/ReduceScatter 自定义算子样例文档，使中英文读者能按一致且可执行的安装与运行说明使用样例。
主要改动
- RFC 0002 英文架构图改为 Mermaid: 将英文架构图替换为英文
Mermaid图，保留插件管理器、PluginBroker、算法实现/选择库及其回退关系等关键元素。 - RFC 0003 类型名与交付状态统一: 统一
AlgAttrs类型名，并在中英文文档中区分 UT 计划覆盖范围与当前仅交付algo_desc组的实际状态。 - 样例安装与测试指引修正: 补齐 AllGather/ReduceScatter 的 AIV 中文安装信息及 AIV/CCU 英文测试源码位置，明确命令须从仓库根目录执行，并删除目录树中实际不存在的引擎内
testcase分支。 - 中英文文案与渲染修复: 修复中文
npu-smi说明的代码块缩进、日志冒号及 ReduceScatter 路径编号，修正英文data拼写与 ReduceScatter 冠词使用。 - 目录树与参考链接规范化: 统一六组样例的目录树符号与相关路径，将运行参数解释移出 shell 代码块，整理 pre-commit 表格表头空格，并注明英文参考链接指向中文架构文档。
Incorrect?
atomgit-bot
Sep 15 Comments：
Sep 15 Comments：
🤖 本次改动均为数据 / 生成 / 二进制文件（如测试用例、锁文件、媒体资源），没有可审查的代码逻辑，已跳过 AI 代码审查。
Incorrect?
DiJIa2.0
Sep 15 Comments：
Sep 15 Comments：
/compile
Sep 15 Pre merge succeeded (commit_id: d669d3734cb7cc974f8ab4c146de35292fce815f)
Sep 15 Added label: cann-cla/yes
CANN-robot
Sep 15 Comments：
Sep 15 Comments：
Thanks for your pull-request.
The full list of commands accepted by me can be found at here.
You can get sig-info at here.
You can self-configure the PR merge rules for this repository. For more details, please refer to Here.
For more, you also can visit HICANN.
PR Approval Progress
✅ Congratulations! All modules have met the lgtm and approve requirements.
Module Approval Details
| module | lgtm status | approve status |
|---|---|---|
| docs | ✅ 臧燕, 颜业峰, 钟宇 (3/2) | ✅ 臧燕, 颜业峰 (2/1) |
| docs/zh/rfcs | ✅ 钟宇, 颜业峰 (2/2) | ✅ 颜业峰 (1/1) |
| examples | ✅ 颜业峰, 钟宇 (2/2) | ✅ 颜业峰 (1/1) |
| experimental | ✅ 颜业峰, 钟宇 (2/2) | ✅ 颜业峰 (1/1) |
💡 Tip:
- Committer can comment
/approveor/lgtm- Commenting
/approveimplies both code review (lgtm) and intent to merge (approve)
CLA Signature Pass
weixin_43960572, thanks for your pull request. All authors of the commits have signed the CLA. 👍
CANN-robot
Sep 15 Comments：
Sep 15 Comments：
CANN-robotSep 15 Set adum,leabclove,yanglianxiang2,flyswa,linyf950,yanzhenghang,chenliang267,claire8090,yanyefeng,zhongyu1,chenhao_,songmingyang,wenxuemin,yangshaohua,bz_lee,chenyia,zhangxp1030,silencesirius as approver
Sep 15 Set adum,leabclove,yanglianxiang2,flyswa,linyf950,yanzhenghang,chenliang267,claire8090,yanyefeng,zhongyu1,chenhao_,songmingyang,wenxuemin,yangshaohua,bz_lee,chenyia,zhangxp1030,silencesirius as approver
Sep 15 Set leabclove,flyswa,claire8090,yanyefeng,wenxuemin,zhangxp1030 as approver
CANN-robot
Sep 15 Comments：
Sep 15 Comments：
| 🚀 CI 流水线已启动 |
|---|
| 📋 执行详情: 点击查看流水线 |
Sep 15 Added label: ci-pipeline-running
8 event messages are collapsed here。 See more
Sep 15 Modify description of pull request
DiJIa2.0
Sep 15 Comments：
Sep 15 Comments：
/compile
Sep 15 Pre merge succeeded (commit_id: 3d32d9d384369eb4bb6db2cd8f805a75a9a38eca)
CANN-robot
Sep 15 Comments：
Sep 15 Comments：
| 🚀 CI 流水线已启动 |
|---|
| 📋 执行详情: 点击查看流水线 |
Sep 15 Removed label: ci-pipeline-failed
8 event messages are collapsed here。 See more
Sep 15 Modify description of pull request
DiJIa2.0
Sep 15 Comments：
Sep 15 Comments：
/compile
Sep 15 Pre merge succeeded (commit_id: 3084b55ac0dc26ca95dfd8ea62461f017465514f)
CANN-robot
Sep 15 Comments：
Sep 15 Comments：
| 🚀 CI 流水线已启动 |
|---|
| 📋 执行详情: 点击查看流水线 |
Sep 15 Removed label: ci-pipeline-failed
Sep 15 Added label: ci-pipeline-running
Sep 15 Removed label: ci-pipeline-running
Sep 15 Added label: ci-pipeline-passed
zhongyu
Sep 16 Comments：
Sep 16 Comments：
/lgtm
philo
Sep 16 Comments：
Sep 16 Comments：
/approve
Sep 16 Added label: lgtmapproved
Sep 16 Merged pull request
描述
修复文档审计中确认的中英文信息缺失、错误路径指引和渲染问题，使读者能按一致的安装与执行说明使用样例。
关联的Issue
Closes #719
https://gitcode.com/cann/hccl/issues/719
测试
git diff --check通过。check_pr.sh、check_md_files.py和仓库配对配置执行完整本地PR检查，20份Markdown双语配对及PNG路径检查通过。pre-commit run --files <20份Markdown及1张PNG>通过；clang-format无适用文件，OAT扫描新增PNG并通过。文档更新
更新RFC 0002/0003、pre-commit指导、P2P/AllGather/ReduceScatter样例README及recursive_executor英文参考链接，共20份Markdown文件，并新增1张英文PNG架构图。
类型标签
合入检查