已合并
docs(readme): 重写首页 README,对齐 0.7.0 开源发布 #128
docs(readme): 重写首页 README,对齐 0.7.0 开源发布 #128
已合并
mayafei创建于 25 天前
mayafei
25 天前

背景

首页 README 停留在旧口径:算子列表与 samples/ 下的实际内容对不上,快速上手缺少可直接执行的安装步骤(CANN 安装、Python 包安装),最新动态也没有反映 09-29 / 09-30 两批合入的算子。本次按 0.7.0 开源版本重写首页,篇幅 95 行 → 273 行。

改动一:README.md 全文重写

章节 说明
最新动态 收敛为 2026-09-30 三条:DeepSeek V4.1 算子覆盖、新增 17 个算子样例(含 AscendC 对标加速比)、0.7.0 发布与样例运行 / Native 打包
概述 重写为 CANNBot 在 CANN 社区中的定位
软硬件配套说明 版本号逐项列出,不再写区间;CANN 只保留稳定版本
快速上手 四步:装 CANN(含镜像 wget 直下命令与 x86_64 / aarch64 说明)、python -m pip install cannbot-dsl、运行一个算子、运行精度测试
算子列表 30 行,逐样例给出接口名、支持架构与仓内相对链接
文档导航、目录结构、相关信息 新增,补上文档站入口、样例目录树与仓群说明

改动二:docs/.vitepress/theme/ 为 /api/** 各页注入「尝鲜版本」提示

  • index.ts:由 export default DefaultTheme 改为 extends: DefaultTheme + doc-before 插槽,按 page.relativePath 以 api/ 前缀判断,只对 API 章节注入;
  • custom.css:新增 .preview-notice 样式。

改主题一处即可覆盖全部 API 页,无需改动 markdown 文件本身。

验证

  • 文档站 npm run build 通过(50.06s,无死链);
  • 算子列表 30 行与 samples/ 下实际样例逐一对齐,本批 17 个新增算子全部在表内;
  • 全文相对链接与中文锚点逐条核对。

说明

README 中保留了若干 <!-- TODO --> 注释,均为发布前待复核项(例如 pip 源上架后的版本号复核),不会渲染到页面。

🤖 Generated with Claude Code

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 mayafei 的贡献)
Mmayafei
25 天前 创建了 pull request,commit 9301a9c7
CANN-robotCANN-robot成员
25 天前 添加了label:stat/needs-squash
CANN-robotCANN-robot成员
25 天前 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
25 天前 评论:

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
repo-cann/cannbot-dsl ✅ liujun2025, yang-jiwei (2/2) ✅ liujun2025, yang-jiwei (2/1)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)

CLA Signature Pass

mayafei, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
mayafei
25 天前 评论:

/compile

likedislike
Mmayafei
25 天前 预合并成功(commit_id: bfe47b47ee9b31d17a84c03e2c4e06199b129cf9)
CANN-robot
CANN-robot成员
25 天前 评论:
🚀 CI 流水线已启动
📋 执行详情: 点击查看流水线
likedislike
CANN-robotCANN-robot成员
25 天前 添加了label:ci-pipeline-running
CANN-robotCANN-robot成员
25 天前 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
25 天前 添加了label:ci-pipeline-passed
yang-jiwei成员
25 天前 评论:

/lgtm
/approve

likedislike
CANN-robotCANN-robot成员
25 天前 添加了label:approved
liujun2025成员
25 天前 评论:

/lgtm
/approve

likedislike
CANN-robotCANN-robot成员
25 天前 添加了label:lgtm
CANN-robotCANN-robot成员
25 天前 合入了pull request