贡献文档

感谢你对 NEC 文档站点的关注！本指南帮助你快速开始贡献。

​

如何贡献

​

方式一：直接在 GitHub/Gitee 上编辑

1. 导航到你想要编辑的页面
2. 点击 “Edit this file” 按钮（铅笔图标）
3. 修改内容并提交 Pull Request

​

方式二：本地开发

1. Fork 并克隆本仓库
2. 安装 Mintlify CLI：
   npm i -g mint
   
3. 创建功能分支
4. 进行修改
5. 在 docs 目录下运行：
   mint dev
   
6. 在 http://localhost:3000 预览更改
7. 提交更改并发起 Pull Request

更多本地开发细节，请参考 开发指南。

​

写作规范

• 使用主动语态：“运行命令” 而不是 “命令应该被运行”
• 直接面向读者：使用 “你” 而不是 “用户”
• 保持简洁：一个句子只表达一个意思
• 先讲目标： instructions 从用户想要完成的事情开始
• 术语一致：同一概念不要交替使用不同同义词
• 包含示例：展示，而不仅仅是讲述