1.8 KiB
1.8 KiB
name, description
| name | description |
|---|---|
| edge-project-overview | edge_collector 项目概览维护规范。用于读取、生成或更新本仓库项目总览,沉淀边缘侧、云平台、前端、协议采集、脚本部署、远程主机、运行目录、动态配置保护和常用验证命令,帮助新任务快速建立上下文。 |
edge_collector 项目概览
何时使用
- 用户要求“整理项目概览”“说明当前工程结构”。
- 新增较大功能前需要建立上下文。
- 部署、协议、前端、云端多模块同时涉及。
- 文档或 skill 需要引用项目约定。
建议落点
默认维护:
docs/project-overview.md
如果已有同类文档,优先更新已有文档,不新增重复总览。
必须覆盖
项目定位
模块结构
边缘侧服务
云平台服务
前端应用
协议采集架构
运行目录 runtime/edge
配置文件与动态配置保护
构建与打包脚本
部署与同步脚本
常用远程主机
常用验证命令
风险与注意事项
推荐阅读路径
事实来源
生成或更新概览时优先读取:
CMakeLists.txt、collector/CMakeLists.txtpackage.shdeploy_cloud.shscripts/migrate_edge.shscripts/install_all.shfrontend/*/package.jsonconfigurator/config/collector/docs/.agents/skills/
环境与主机
概览可记录常用主机,但不要写敏感密钥:
- 82:常用 arm64 发布构建主机。
- 97:arm64 编译/同步验证主机。
- 94、87:边缘运行验证主机。
- 云平台:
119.45.4.75。
输出要求
- 明确“已确认事实”和“从文件推断”。
- 不把历史临时问题写成永久事实。
- 动态配置保护规则要写清楚,避免打包/同步覆盖运行配置。
- 同主机编译部署也要使用
scripts/migrate_edge.sh的规范需要写入。