Files
Cyrene/debug/dev_must_read.md
T
AskaEth a67b95cbc4 fix: IoT多设备支持 + Review Pipeline审查消息 + 意图分析快速通道优化
- IoT Provider: 重写Execute()支持多设备命令批量执行,修复persona路径
- Intent Analyzer: 新增isStrongIoTCommand快速通道,跳过LLM分析节省2-3s
- Orchestrator: parseReviewMessages()内联审查 + 快速通道扩展(chat/greeting跳过子会话)
- Gateway: SSE review_messages解析→WebSocket结构化消息转发(action/chat)
- Persona: 对话风格注入action格式指令(括号包裹动作描述)
- Frontend: sessionStore历史消息msgType映射
- 新增E2E测试脚本 + 调试标准文档 + 第4轮修复报告

E2E验证: IoT设备操控 Review消息拆分 快速通道 响应时间~3.4s

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-22 22:51:27 +08:00

2.5 KiB

项目开发文档管理规范 (修订版)

1. 文档管理目录结构

  • ./docs/progress/
    请在此目录下定期创建进度 md 文件,以便后续对话能顺利继承开发进度。

  • ./docs/decisions/
    请在此目录下创建决策 md 文件,以便后续对话能准确继承开发决策。

  • ./docs/tasks/
    请在此目录下为每次任务创建 md 文件,以便后续对话能回顾开发任务详情。

  • 你可以按需求使用或创建其他文档目录。

  • 开发前可以通过阅读已有的文档回顾开发进度。

2. 通用文档规范

  • ./docs/ 目录下,请按统一格式创建辅助文档或文件夹,便于后续开发参考:
    格式: YYYY-MM-DD_HH-mm-SS-topic.md
  • 每次开启新对话或处理新任务前,建议先浏览这些文件获取上下文。

3. 文档的创建与维护

  • 你可以在思考或任务执行过程中,随时新建、修改或删除这些文档,动作可以频繁一些喵~
  • 已实现、调试通过且功能完善的模块,请在对应的 md 文件中做好统一标记,避免后续频繁重复阅读。
  • 在完成功能重大调整与开发后请及时编写或修改 ./docs/api-reference/ 下的文档,和项目根目录下的 Deploy.md

4. 调试与测试

  • 调试功能时,可以在终端启动 devtools.sh 脚本:
    使用 curl 启动所有服务,再通过 curl 等工具对实现的功能进行接口调试。
    devtools 提供的 API 可启动各前后端服务,请牢记这个流程喵!
  • 涉及到需要浏览器操作去验证前端或后端接口时,可以启动 Chromium 的自动化控制模式。 启动后访问 http://localhost:9222/json (端口可能不一致) 就能看到所有可操控的页面列表,拿到 webSocketDebuggerUrl 就能通过 WebSocket 直接发 CDP 指令。

5. 数据库连接

  • 使用根目录的 docker-compose.dev.db.yml 创建开发环境的数据库容器。若存在仅启动。若启动无需重启。

6. 版本提交规范

  • 当用户要求的某个功能已完全修复、编写完成并验证成功后,可向当前分支(如 dev)进行推送。
  • 禁止提交的内容: docs/ 文件夹以及编译后的二进制文件、其他语言环境的依赖和项目临时环境。

7. 测试脚本临时管理

  • 在测试长脚本或复杂命令时,可以在 debug 目录临时创建 cache 文件夹,并在其中新建 sh, py 等脚本文件并运行。
  • 注意: 用完记得及时删除喵~