已合并
补充一级目录下md文档和docs目录下md文档英文 #7848
yanglu-1创建于 7月23日
补充一级目录下md文档和docs目录下md文档英文 #7848
已合并
yanglu-1创建于 7月23日
yanglu-1成员
7月23日

描述

补充一级目录md文档和docs目录下md文档英文

关联的Issue

https://gitcode.com/yanglu-1/ops-nn_7561/issues/1

测试

文档更新

类型标签

AI/Agent生成声明

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 yanglu-1 的贡献)
Yyanglu-1成员
7月23日 创建了 pull request,commit 18b60e94
Yyanglu-1成员
7月23日 关联了issue:[Documentation|文档反馈]: 补充一级目录md文档和docs目录下md文档英文
atomgit-bot
atomgit-bot
7月23日 评论:

变更摘要

本次 PR 主要为项目根目录和 docs/ 目录下的 Markdown 文档补充了完整的英文版本,包括新增英文 README、贡献指南以及 docs/ 下各组件的英文技术文档,总计涉及 33 个文件,新增约 4628 行内容。

主要改动

  • 新增 README.en.md:在项目根目录创建了英文版 README 文件,为国际用户提供项目介绍和入门指引。
  • 新增 CONTRIBUTING.mdCONTRIBUTING.en.md:将原有的 CONTRIBUTING.md 重命名为英文版 CONTRIBUTING.en.md,同时新增中文版 CONTRIBUTING.md,形成中英文双版本贡献指南。
  • 新增 docs/README.en.md:为 docs/ 目录创建英文版索引文档,便于英文用户浏览文档结构。
  • 批量补充 docs/ 下各子目录的英文版 .md 文档:在 docs/ 的多个子目录中新增了对应的 .en.md 或英文命名的 Markdown 文件,覆盖了各模块的技术文档英文化。
likedislike
atomgit-bot
atomgit-bot
7月23日 评论:

代码审查

I've completed the review of all 33 changed files. Let me now provide the closing summary.


审查总结

已审查的文件(33 个)

文件 审查结果
CHANGELOG_en.md 无问题
CONTRIBUTING_en.md 无问题
QUICKSTART.md 仅有空白字符清理(去除行尾空格),无问题
QUICKSTART_en.md 无问题
README_en.md 无问题(除已报告的链接错误外)
SECURITY_en.md 无问题
docs/CONTRIBUTING_DOCS_en.md 无问题
docs/README_en.md P2:1 处断链basic_concepts.md → 应为 basic_concept.md
docs/en/context/aclnn_return_code.md 无问题
docs/en/context/basic_concept.md P1:9 处断链(10 个链接中 9 个指向不存在的文件名)
docs/en/context/broadcast_relationship.md 无问题
docs/en/context/build.md 无问题
docs/en/context/compilation and running sample.md 无问题
docs/en/context/conversion_relationship.md 无问题
docs/en/context/data_format.md 无问题
docs/en/context/data_structure.md 无问题
docs/en/context/data_type.md 无问题
docs/en/context/deduction_relationship.md 无问题
docs/en/context/dir_structure.md 无问题
docs/en/context/non_contiguous_tensor.md 无问题
docs/en/context/quant_more_introduction.md 无问题
docs/en/context/quick_install.md 无问题
docs/en/context/sparse_mode_introduction.md 无问题
docs/en/context/tensor_scalar_deduction_relationship.md 无问题
docs/en/context/two_phase_api.md 无问题
docs/en/debug/cann_simulator.md 无问题
docs/en/debug/op_debug_prof.md 无问题
docs/en/develop/aicore_develop_guide.md 无问题
docs/en/develop/aicpu_develop_guide.md 无问题
docs/en/develop/graph_develop_guide.md 无问题
docs/en/invocation/op_invocation.md 无问题
docs/en/invocation/quick_op_invocation.md 无问题
docs/zh/debug/op_debug_prof.md 仅有空白字符清理 + 锚点修正(从 / 语法错误修复为正确格式),无问题

按优先级统计

  • P0: 0
  • P1: 1(basic_concept.md 中 9 个断链将导致用户无法从概念索引页导航)
  • P2: 1(docs/README_en.mdbasic_concepts.md 拼写错误)
  • P3: 0

整体风险评估

中低风险。本次 PR 是一个纯文档翻译提交,没有涉及代码逻辑变更。发现的两个问题均为文档内部链接错误:basic_concept.md 中 10 个链接有 9 个指向不存在的文件名(命名约定与中文源文件不一致),以及 docs/README_en.md 中一处拼写错误。这些问题不会影响运行时行为或安全性,但会导致文档用户点击链接时出现 404 错误。未发现危险命令、不安全的配置指导或安全漏洞。

类型 数量
🔴 阻塞 1
🟡 建议 4

⛔ 需要修改

likedislike
CANN-robotCANN-robot成员
7月23日 添加了label:cann-cla/yes
此处折叠了62条消息 查看更多
chenjiao成员
7月23日 评论:

/lgtm
/approve

likedislike
CANN-robotCANN-robot成员
7月23日 添加了label:lgtmapproved
CANN-robotCANN-robot成员
7月23日 解决了最后一个问题
CANN-robotCANN-robot成员
7月23日 合入了pull request
CANN-robot
CANN-robot成员
7月23日 评论:

Pull Request 已合并或已关闭。

If you want to solve this problem, you can click here to do it in the FAQs.

likedislike