From 6209c865fd6e0d70df763132e4497b825952deec Mon Sep 17 00:00:00 2001 From: 7418 <7418@openclaw.ai> Date: Sun, 1 Mar 2026 09:41:14 +0800 Subject: [PATCH] =?UTF-8?q?refactor:=20=E6=95=B4=E7=90=86=20docs=20?= =?UTF-8?q?=E7=9B=AE=E5=BD=95=E7=BB=93=E6=9E=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - docs/handover/ — 交接文档（架构、设计决策） - docs/research/ — 调研文档（技术方案、可行性分析） - 各目录添加 README.md 索引，要求 AI 增删文件时更新索引 - CLAUDE.md 更新文档路径引用 Co-Authored-By: Claude Opus 4.6 --- CLAUDE.md | 6 +++--- docs/handover/README.md | 12 ++++++++++++ docs/{ => handover}/agent-tooling-todo-bridge.md | 0 docs/{ => handover}/bridge-system.md | 0 docs/research/README.md | 12 ++++++++++++ .../chat-sdk-integration-feasibility.md | 0 .../{ => research}/context-storage-migration-plan.md | 0 7 files changed, 27 insertions(+), 3 deletions(-) create mode 100644 docs/handover/README.md rename docs/{ => handover}/agent-tooling-todo-bridge.md (100%) rename docs/{ => handover}/bridge-system.md (100%) create mode 100644 docs/research/README.md rename docs/{ => research}/chat-sdk-integration-feasibility.md (100%) rename docs/{ => research}/context-storage-migration-plan.md (100%) diff --git a/CLAUDE.md b/CLAUDE.md index 2fb5fda..cf1c353 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -65,10 +65,10 @@ CodePilot — Claude Code 的桌面 GUI 客户端，基于 Electron + Next.js。 - **Requirements**（系统要求、依赖说明） - **Changelog**（自上一版本以来的 commit 列表） -## Architecture Docs +## Docs 目录 -- [Agent Tooling & TodoWrite Bridge](docs/agent-tooling-todo-bridge.md) — SDK → SSE → DB 事件流、TodoWrite 字段映射、tool_result 三层去重策略 -- [多 IM 远程会话桥接系统](docs/bridge-system.md) — Telegram 远程操控 Claude 会话，含目录结构、数据流、关键设计决策 +- `docs/handover/` — 交接文档（架构、数据流、设计决策）。**检索前先读 README.md；增删文件后更新索引。** +- `docs/research/` — 调研文档（技术方案、可行性分析）。**同上。** ## Build Notes diff --git a/docs/handover/README.md b/docs/handover/README.md new file mode 100644 index 0000000..d774d8d --- /dev/null +++ b/docs/handover/README.md @@ -0,0 +1,12 @@ +# Handover / 交接文档 + +系统架构、数据流、关键设计决策的持久化记录，供后续开发者（含 AI）快速上手。 + +**AI 须知：修改或新增文件后更新下方索引；检索本目录前先读此文件。** + +## 索引 + +| 文件 | 主题 | +|------|------| +| agent-tooling-todo-bridge.md | SDK → SSE → DB 事件流、TodoWrite 字段映射、去重策略 | +| bridge-system.md | 多 IM 远程桥接系统架构（目录结构、数据流、设计决策） | diff --git a/docs/agent-tooling-todo-bridge.md b/docs/handover/agent-tooling-todo-bridge.md similarity index 100% rename from docs/agent-tooling-todo-bridge.md rename to docs/handover/agent-tooling-todo-bridge.md diff --git a/docs/bridge-system.md b/docs/handover/bridge-system.md similarity index 100% rename from docs/bridge-system.md rename to docs/handover/bridge-system.md diff --git a/docs/research/README.md b/docs/research/README.md new file mode 100644 index 0000000..cda2025 --- /dev/null +++ b/docs/research/README.md @@ -0,0 +1,12 @@ +# Research / 调研文档 + +技术方案调研、可行性分析、POC 验证记录。 + +**AI 须知：修改或新增文件后更新下方索引；检索本目录前先读此文件。** + +## 索引 + +| 文件 | 主题 | +|------|------| +| chat-sdk-integration-feasibility.md | Vercel Chat SDK 集成可行性调研 | +| context-storage-migration-plan.md | 上下文共享与存储迁移设计 | diff --git a/docs/chat-sdk-integration-feasibility.md b/docs/research/chat-sdk-integration-feasibility.md similarity index 100% rename from docs/chat-sdk-integration-feasibility.md rename to docs/research/chat-sdk-integration-feasibility.md diff --git a/docs/context-storage-migration-plan.md b/docs/research/context-storage-migration-plan.md similarity index 100% rename from docs/context-storage-migration-plan.md rename to docs/research/context-storage-migration-plan.md