文档更新

2026-10-01 14:46:36 +08:00 · 2026-06-19 14:43:22 +08:00
parent 9eeeb09d2f
commit cc5e53c51e
48 changed files with 226 additions and 4612 deletions
@@ -3,7 +3,6 @@
 > **文档类型**：实现计划（Implementation Plan）  
 > **创建日期**：2026-06-18  
 > **状态**：实施中（阶段 5 收尾；控制台 `/api/v1/d/*` + 新前端已落地，legacy 兼容层已撤销）
-> **前置阅读**：[`Wavelet/AGENTS.md`](../../Wavelet/AGENTS.md)、[`docs/guideline/Constraints.md`](../guideline/Constraints.md)、[`docs/design/architecture.md`](../design/architecture.md)

 ---

@@ -822,12 +821,3 @@ curl http://127.0.0.1:3000/api/agent/config-versions/active \
 | M6 生产就绪 | 第 12 周 | 迁移脚本 + 部署文档 + Handover |

 ---
-
-## 14. 参考文档
-
- [`Wavelet/AGENTS.md`](../../Wavelet/AGENTS.md)
- [`docs/design/architecture.md`](../design/architecture.md)
- [`docs/design/agent-design.md`](../design/agent-design.md)
- [`docs/guideline/Constraints.md`](../guideline/Constraints.md)
- 旧后端源码：`openflare-server/internal/`
- 子智能体分析报告：本计划编制依据（2026-06-18）
@@ -0,0 +1,53 @@
+# 文档更新 — AI 接手文档
+
+> **状态**：已完成（2026-06-19）  
+> **背景**：`openflare-server/` 子目录已删除，项目收敛为 monorepo；后端迁移至 Wavelet 框架，前端迁移至 `frontend/`  
+> **触发**：多智能体并行分析后批量更新文档
+
+---
+
+## 1. 分析结论摘要
+
+| 维度 | 主要变化 |
+| --- | --- |
+| 仓库形态 | 单 monorepo（`github.com/Rain-kl/Wavelet`），无 `openflare-server/` 子目录 |
+| Server 入口 | `main.go` + `internal/cmd/`，非 `cmd/server/` |
+| 后端分层 | `internal/apps/*/routers.go` + `logics.go`，非 `controller/service` |
+| 管理 API | `/api/v1/d/*`，Session Cookie 鉴权，非 `OPENFLARE_TOKEN` |
+| 边缘 API | `/api/v1/agent|relay|tunnel/*` |
+| 前端 | `frontend/`，路由共置于 `app/(main)/`，非 `features/store` |
+| 配置 | `config.yaml` + `APP_*`/`DB_*` 环境变量，非 `JWT_SECRET`/`DSN` |
+
+## 2. 已更新文档（P0）
+
+| 文件 | 更新内容 |
+| --- | --- |
+| `docs/design/index.md` | 重写 §仓库结构（monorepo、Wavelet 分层、API 前缀、Frontend 结构） |
+| `docs/design/architecture.md` | Server 描述、鉴权方式、启动入口 |
+| `docs/design/agent-design.md` | Agent API 路径 `/api/v1/agent/*` |
+| `docs/reference/cli.md` | 全部命令改为仓库根目录执行 |
+| `docs/reference/index.md` | 仓库结构描述 |
+| `docs/deployment/deployment.md` | Compose、源码启动、配置变量 |
+| `docs/deployment/server.md` | 前端构建路径、启动命令、环境变量 |
+| `docs/deployment/openflared.md` | Tunnel API 路径、编译命令 |
+| `docs/deployment/relay.md` | 编译命令 |
+| `docs/deployment/agent.md` | 源码构建路径 |
+| `docs/guideline/Constraints.md` | **新建**，消除全站断链 |
+| `AGENTS.md` | 修正 skill/demo 路径 |
+| `README.md` | 快速开始指向根目录 compose |
+
+## 3. 待跟进（P1）
+
+- [ ] `docs/reference/configuration.md` — 与 `config.example.yaml` / `.env.example` 对齐
+- [ ] `docs/guide/quick-start.md`、`troubleshooting.md` — 鉴权与路径修正
+- [ ] `docs/deployment/server.md` — Docker Compose 示例段落（后半部分仍有过时内容）
+- [ ] `docs/DEPLOYMENT.md` — Wavelet 脚手架残留
+- [ ] `docs/design/tunnel-design.md`、`pages-design.md` — API 前缀统一
+- [ ] `docs/changelog/index.md` — JWT_SECRET 声明与代码对齐
+- [ ] `docs/en/**` — 英文镜像同步（低优先级）
+
+## 4. 文档维护原则
+
+1. **单一事实来源**：配置以 `config.example.yaml` + `.env.example` 为准；目录以 `docs/design/index.md` 为准；API 以 `make swagger` 为准。
+2. **禁止再引用**：`openflare-server/`、`OPENFLARE_TOKEN`、`JWT_SECRET`（除非代码重新引入）。
+3. **中英文分工**：功能变更先更新中文文档；英文可标记待同步。
@@ -223,6 +223,5 @@ go run . scheduler
 | [实现计划](./20260618-openflare-wavelet-backend-migration.md) | 模块清单、§12 端点对照 |
 | [前端迁移计划](./20260618-openflare-wavelet-frontend-migration.md) | UI 迁移与验收 |
 | [`Wavelet/AGENTS.md`](../../Wavelet/AGENTS.md) | 框架 Guardrails |
-| [`docs/guideline/Constraints.md`](../guideline/Constraints.md) | 开发约束 |
 | 旧后端源码（对照用） | `openflare-server/internal/` |
 | Changelog | [`docs/changelog/index.md`](../changelog/index.md) `[Unreleased]` |
@@ -18,6 +18,7 @@
 | [OpenFlare → Wavelet 前端迁移计划](./20260618-openflare-wavelet-frontend-migration.md) | 将 `openflare-server/web` 业务 UI 按 Wavelet 设计风格重写，复用框架组件与 Admin 基建 |
 | [OpenFlare 前端迁移 — AI 委派](./handover-openflare-frontend-migration.md) | 前端迁移任务队列与验收状态 |
 | [前端路由验证](./verify-frontend-routes.md) · [Service 验证](./verify-frontend-services.md) · [UI 验证](./verify-frontend-ui.md) · [构建验证](./verify-frontend-build.md) | 多角度迁移验收报告 |
+| [文档结构更新 — AI 接手](./handover-docs-restructure-update.md) | 重构后多智能体分析结论与文档批量更新记录 |

 ## 使用建议