modify: 说明文档

This commit is contained in:
2026-08-05 18:23:12 +08:00
parent 698ee5bf20
commit 9ecf3176b5
2 changed files with 71 additions and 0 deletions
+39
View File
@@ -0,0 +1,39 @@
# GitHub Copilot Agent 配置
本目录包含 Chongming-Zenoh 项目的 **GitHub Copilot 自定义 Agent** 定义,用于在 VS Code 中使用 AI 辅助开发时提供项目专属的上下文和指导。
---
## 文件说明
| 文件 | 说明 |
| -------------------- | ----------------------------------------------------------------- |
| `chongming.agent.md` | Chongming 项目的 Agent 定义文件,包含完整的项目架构知识和开发规范 |
| `README.md` | 本文件 |
---
## Agent 功能
`chongming.agent.md` 定义了名为 **chongming** 的 Copilot Agent 模式。激活后,AI 助手将获得以下项目专属知识:
- 项目总体架构(FastAPI + Zenoh + Vue 3)
- 核心数据流和启动流程
- 添加 Worker 插件的完整开发工作流
- 为现有插件添加 RPC 端点
- 配置驱动路由的修改方法
- 前端开发指导(Element Plus、Pinia、Vue Router)
- TOML 配置字段速查
- 常用命令和注意事项
---
## 使用方式
在 VS Code 中,通过 Copilot Chat 选择 **chongming** Agent 模式,或在对话中提及项目相关问题时,AI 助手将自动使用该 Agent 提供的项目上下文进行回答。
---
## 维护
当项目架构或开发规范发生变化时,同步更新 `chongming.agent.md` 文件以确保 AI 助手的指导始终保持准确。