-
Notifications
You must be signed in to change notification settings - Fork 8
Docs: add design doc #283
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: trailhead_agent
Are you sure you want to change the base?
Docs: add design doc #283
Conversation
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
avoid unused new line
docs/design-doc.md
Outdated
@@ -0,0 +1,396 @@ | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
also a unused newline
docs/design-doc.md
Outdated
### 5.3 技术架构 | ||
|
||
``` | ||
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ | ||
│ 客户端应用 │ │ CodeAgent │ │ AI 服务商 │ | ||
│ (GitHub/API) │───▶│ 网关平台 │───▶│ (Claude/Gemini)│ | ||
└─────────────────┘ └─────────────────┘ └─────────────────┘ | ||
│ | ||
▼ | ||
┌─────────────────┐ | ||
│ 账号池管理 │ | ||
│ 负载均衡 │ | ||
└─────────────────┘ | ||
│ | ||
▼ | ||
┌─────────────────┐ | ||
│ Workflow 引擎 │ | ||
│ 流程管理 │ | ||
└─────────────────┘ | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
这里是有图片的,没放在这个文档里
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
可以调整一下这块markdown区域的对齐
docs/design-doc.md
Outdated
| **负载均衡** | 计划支持 | 无 | 无 | | ||
| **API 接口** | 计划支持 | 无 | 无 | | ||
| **监控统计** | 计划支持 | 无 | 无 | | ||
| **团队协作** | GitHub 集成 | 本地使用 | 本地使用 | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Claude Code 可以跟 git 结合,需集成 github action,但 prompt 黑盒
**CodeAgent 劣势**: | ||
- **部署复杂度**:需要配置 Webhook 和服务器 | ||
- **学习成本**:需要了解 GitHub 集成流程 | ||
- **依赖外部服务**:需要 GitHub 和 AI 服务商 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
这里直接引出 -> AI 智能网关竞品分析,有点生硬
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
在分析了与 Claude Code 和 Gemini-Cli 的对比后,我们发现 CodeAgent 在 GitHub 集成和团队协作方面具有明显优势。然而,随着 AI 服务市场的快速发展,出现了一批专注于 AI 服务管理和优化的智能网关产品。这些产品在账号管理、负载均衡、成本控制等方面提供了更专业的解决方案,值得我们深入分析。
中间加上这段话可以吗
docs/design-doc.md
Outdated
### 6.3 技术架构 | ||
|
||
``` | ||
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
这样可以引入流程图 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok
docs/流程图.png
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
这里图片的命名换成英文命名更好些;当然不是说中文不能用,而是英文更少坑、更通用、更可维护;
修改了设计文档
增加了对比以及workflow相关内容