内部部署与使用

本地运行

在 Document/通信协议 目录执行：

npm install
npm run docs:dev

说明：

• PowerShell 5.x 不支持 &&，请使用分行或 ;。
• 默认访问地址为 http://localhost:5174。

内部发布建议

1. 由 CI 执行 npm run docs:build 产出静态文件。
2. 将 .vitepress/dist 发布到内部静态站点（如 Nginx/对象存储/CDN）。
3. 仅内部网络开放全量文档入口。

提交流程约束（已落地）

• 仓库已新增 /.github/PULL_REQUEST_TEMPLATE.md。
• 所有涉及协议/代码的 PR 必须勾选“协议影响检查”和“文档同步检查”。
• 评审时请重点确认：
  • 协议是否有第二事实来源或静默默认值
  • 协议对比文档 与 NCS协议支持矩阵 是否同步更新
  • 是否补充了 代码-协议双向同步 与 版本变更记录

自动化守门（建议在 CI 执行）

脚本位置：

• sync_tools/check_protocol_doc_sync/check_protocol_doc_sync.ps1

本地检查当前改动：

pwsh .\sync_tools\check_protocol_doc_sync\check_protocol_doc_sync.ps1

按分支范围检查（CI 推荐）：

pwsh .\sync_tools\check_protocol_doc_sync\check_protocol_doc_sync.ps1 -BaseRef origin/main -HeadRef HEAD

目录说明

• 私有协议.md：私有协议正文
• 开放协议.md：开放协议正文
• 协议对比文档.md：双协议详细对比
• NCS协议支持矩阵.md：各项目支持状态
• 代码-协议双向同步.md：改动联动清单与记录
• 版本变更记录.md：版本与发布说明