贡献指南

本项目欢迎广大开发者体验并参与贡献,在参与社区贡献之前,请参见cann-community了解行为准则,进行CLA协议签署,了解源码仓的贡献流程。

符合要求的文档将会在CANN文档中心呈现。

本项目支持Markdown格式的内容贡献,对应地可创建.md为后缀的文档或修改已存在的文档。

贡献范围

我们欢迎任何能提升文档质量的贡献,包括但不限于:

纠错与改进:修复错别字、语法错误、错误的代码示例、过时的信息或失效的链接。

澄清与优化:让描述更清晰易懂,优化语句结构,补充背景知识。

内容补充:为现有功能添加使用示例、API文档、常见问题解答(FAQ)、最佳实践或警告说明等。

新内容创作:为新增功能撰写全新的章节或教程,比如算子README、API介绍文档等,如有问题建议先创建Issue讨论。

本地化翻译:帮助我们翻译或校对其他语言的文档。

样式与导航:改进文档网站的布局、可读性和导航结构。

写作要求

请严格遵循文档写作规范。

更新/新增文档

修改文档

如果您需要更新现有文档,可点击CANN文档中心页面右上角的编辑按钮,跳转至源文件。修改该文件,并提交PR即可参与贡献。

新增文档

如果您需要新增文档,请在合适的目录新建Markdown,目录结构说明可参考目录说明。

  1. 新建文件。

  2. 编辑目录索引文件,将新建文件添加到网页。

    以算子库文档为例,新增文件时,先在docs/ops-lib/目录下找到目录文件README.md,该文件即对应算子库文档的组织结构,在对应位置增加链接指向新建的文件。

完成上述操作后,提交PR即可参与贡献。