| title | 贡献文档 |
|---|---|
| description | 如何为 NEC 文档站点贡献力量 |
感谢你对 NEC 文档站点的关注!本指南帮助你快速开始贡献。
- 导航到你想要编辑的页面
- 点击 "Edit this file" 按钮(铅笔图标)
- 修改内容并提交 Pull Request
- Fork 并克隆本仓库
- 安装 Mintlify CLI:
npm i -g mint
- 创建功能分支
- 进行修改
- 在 docs 目录下运行:
mint dev
- 在
http://localhost:3000预览更改 - 提交更改并发起 Pull Request
更多本地开发细节,请参考 开发指南。
- 使用主动语态:"运行命令" 而不是 "命令应该被运行"
- 直接面向读者:使用 "你" 而不是 "用户"
- 保持简洁:一个句子只表达一个意思
- 先讲目标: instructions 从用户想要完成的事情开始
- 术语一致:同一概念不要交替使用不同同义词
- 包含示例:展示,而不仅仅是讲述