参与贡献

AscendMate 是一个开放、共建的一站式昇腾手册。欢迎任何形式的贡献：修错、补充内容、整理 FAQ、优化导航。

欢迎什么

• 修错：补链接、修正版本配套、更正命令。
• 补内容：新增实操教程、某个硬件的部署经验、某个场景的完整实施步骤。
• 整理 FAQ：把一线遇到的高频问题沉淀成可检索的问答。
• 优化导航/检索：让用户更快找到内容。

文档结构与写作

文档基于 VitePress。所有页面在 docs/ 下，按板块分目录：

docs/
├── guide/        # 快速开始
├── setup/        # 环境搭建
├── hardware/     # 昇腾硬件
├── training/     # 大模型训练
├── inference/    # 模型推理
├── ops/          # 算子开发
├── tools/        # 工具链
├── resources/    # 资源导航
├── faq/          # 问题定位
└── contributing/ # 贡献指南

新增页面后，记得在 docs/.vitepress/config.mts 的侧边栏里注册。

写作风格约定

• 面向场景：标题尽量用「我要…」的真实诉求，而不是机械的技术名词。
• 结论先行：开头一句话说明「什么时候读这节」。
• 给命令和验证：每个步骤尽量给可复现的命令与「怎么验证成功」。
• 版本配套：涉及版本的一定写清"以官方配套为准"，避免误导。
• 诚实标注：你没验证过的内容，标注"以官方为准"。

本地预览

npm install
npm run docs:dev   # 启动本地预览

提交流程

1. Fork 本仓库，切换新分支。
2. 修改内容，本地 npm run docs:dev 预览确认。
3. 提交 PR，附上改动说明。

NOTE

翻译/润色、链接失效修正、FAQ 补充都是很有价值的贡献，哪怕很小也欢迎。