gongzhiyong
2a6a709f58
Add a complete docs skeleton for onboarding and integration, including orchestration-plan contract, acceptance matrix, OAuth flow, architecture maps, and milestone status tracking to support Agnet-facing delivery work. Made-with: Cursor
40 lines
2.3 KiB
Markdown
40 lines
2.3 KiB
Markdown
# Heicode 文档入口
|
||
|
||
本目录是 Heicode 仓库的**文档主索引**。整体内容按受众分两条阅读路径，再共享一组通用骨架。
|
||
|
||
## 共用骨架（建议都先读）
|
||
|
||
| 文档 | 用途 |
|
||
|------|------|
|
||
| [`vision-heicode-full-stack-agentic-dev.md`](./vision-heicode-full-stack-agentic-dev.md) | 产品愿景与协作范式（方向性，非排期） |
|
||
| [`glossary.md`](./glossary.md) | 术语表：Heicode / Manager / 客户端 / 子 agent / SK 等 |
|
||
| [`architecture.md`](./architecture.md) | 架构图与关键数据流（mermaid） |
|
||
| [`sk-lifecycle.md`](./sk-lifecycle.md) | SK（Skill 资产）单点真相：来源、快照、刷新、写权边界 |
|
||
|
||
## 路径 A · 内部研发 / 新成员上手
|
||
|
||
适合刚加入团队、负责 `cc-haha`（客户端）或 `new-api`（Manager）开发的同学。
|
||
|
||
1. [`onboarding/README.md`](./onboarding/README.md)：阅读顺序
|
||
2. [`onboarding/local-dev.md`](./onboarding/local-dev.md)：本地联调步骤与排错
|
||
3. [`onboarding/env-variables.md`](./onboarding/env-variables.md)：环境变量手册
|
||
4. 回到共用骨架：[`architecture.md`](./architecture.md) → [`glossary.md`](./glossary.md)
|
||
5. 计划与现状：[`milestones/README.md`](./milestones/README.md)、[`milestones/STATUS.md`](./milestones/STATUS.md)
|
||
|
||
## 路径 B · Agnet / 平台集成方
|
||
|
||
适合实现 Agnet 平台侧、与 Heicode 对接编排或事件流的工程师。
|
||
|
||
1. [`glossary.md`](./glossary.md) → [`architecture.md`](./architecture.md)
|
||
2. [`integration/README.md`](./integration/README.md)：集成方阅读地图
|
||
3. [`sk-lifecycle.md`](./sk-lifecycle.md)：SK 边界（Heicode 端写、Agnet 只读快照）
|
||
4. [`integration/agnet-platform-api-design.md`](./integration/agnet-platform-api-design.md)：详细 API 设计
|
||
5. [`integration/heicode-oauth-flow.md`](./integration/heicode-oauth-flow.md)：HeiCode 客户端 ↔ Manager 浏览器登录流程
|
||
6. 落地节奏：[`milestones/README.md`](./milestones/README.md)（M3–M5）+ [`milestones/STATUS.md`](./milestones/STATUS.md)
|
||
|
||
## 关于版本与更新
|
||
|
||
- 本目录下的文档以 **设计意图与契约语义** 为准；实现细节以仓库代码为准。
|
||
- 任一文档与代码出现冲突时，请在 PR 里同步更新文档与 [`milestones/STATUS.md`](./milestones/STATUS.md)。
|
||
- 受众边界：`docs/` 内不做产品营销文案，营销内容归 `website/`。
|