贡献指南
约 338 字大约 1 分钟
2026-07-21
本页用于说明 NexAPI 文档的本地开发、内容规范和提交建议。
本地开发
安装依赖：
pnpm i启动开发服务：
pnpm docs:dev构建静态站点：
pnpm docs:build本地预览构建结果：
pnpm docs:preview文档写作规范
标题要直接
推荐使用用户能一眼理解的标题，例如：
创建 API 令牌Codex 手动配置额度不足排查
避免使用过于抽象的标题，例如：
高级配置说明问题集合其他事项
步骤要闭环
一篇教程尽量包含：
- 前置条件。
- 操作步骤。
- 成功标志。
- 常见失败原因。
- 下一步链接。
示例要脱敏
示例 API Key 统一写成：
sk-xxxxxxxxxxxxxxxxxxxxxxxx示例 Base URL 使用官方域名：
https://nexapi.ehytech.com/v1提交前检查
提交前建议完成以下检查：
反馈建议
如果你不确定内容是否适合合入，可以先从小改动开始，例如修正文案、补充排障项或完善一个客户端配置步骤。