docs: rewrite README set for unified product delivery

Refresh root, client, and gateway READMEs to present a cohesive HeiCode monorepo story, with clear startup flows and integration guidance for deployment teams. Made-with: Cursor
2026-04-29 21:15:30 +08:00
parent 1efcf73992
commit 191685bfcd
3 changed files with 168 additions and 582 deletions
@@ -0,0 +1,76 @@
+# HeiCode Workspace
+
+一个仓库，交付两套能力：
+
+- `cc-haha`：HeiCode 客户端（CLI + Desktop）
+- `new-api`：TaijiAICloud 网关（含 HeiCode 浏览器登录适配）
+
+这个仓库面向“开箱即用的 Claude Code 体验”产品化，不要求用户手动做复杂配置。
+
+## 为什么是单仓库
+
+- 客户端与平台适配同步迭代，避免版本错位
+- 登录、模型发现、默认模型策略在同一个版本闭环验证
+- 交付给客户时只有一个代码入口，部署和排障路径更短
+
+## 仓库结构
+
+```text
+.
+├── cc-haha/          # HeiCode 客户端主工程
+├── new-api/          # TaijiAICloud 网关工程（已接入 HeiCode OAuth）
+├── package.json
+└── bun.lock
+```
+
+## 一分钟启动
+
+```bash
+# 1) 安装根依赖
+bun install
+
+# 2) 启动 HeiCode 本地服务
+cd cc-haha
+bun run src/server/index.ts
+
+# 3) 新开终端启动桌面端
+cd cc-haha/desktop
+bun run tauri dev
+```
+
+若本地联调网关地址：
+
+```bash
+HEICODE_TAIJIAICLOUD_BASE_URL=http://localhost:3000 bun run src/server/index.ts
+```
+
+## 当前产品特性
+
+- 品牌统一为 `HeiCode`
+- 登录入口聚焦平台登录流程（浏览器 OAuth 优先）
+- 桌面端已移除 Providers 菜单与 GitHub 外链元素
+- 模型选择改为按 Provider API 动态拉全量模型
+- 支持 `taijiaicloud` 与 `clawdrouter` 双平台预设
+
+## 平台侧接口约定（最小集）
+
+- `GET /v1/models`：模型列表发现
+- Anthropic Messages 兼容入口：供 HeiCode 直接调用
+- OAuth 风格授权入口（推荐）：支持桌面端回调到本地 loopback
+
+`new-api` 已实现 HeiCode 登录相关路由：
+
+- `GET /heicode/oauth/authorize`
+- `GET /heicode/oauth/session`
+
+## 文档导航
+
+- 客户端说明：`cc-haha/README.md`
+- 网关说明：`new-api/README.md`
+
+## 交付建议
+
+- 用同一版本标签同时发布客户端与网关镜像
+- 每次发版至少回归三条链路：登录、模型拉取、对话请求
+- 先在本地 docker 联调通过，再做外网域名与证书配置
+