Files
assist/.agents/summary/review_notes.md
zhaojie 11eef49271 docs: 添加项目文档体系 + 修复租户创建模态框
- 新增 .agents/summary/ 完整文档(架构、组件、接口、数据模型、流程、依赖)
- 新增 AGENTS.md(AI 助手导航)
- 更新 README.md
- 修复 dashboard.html 租户模态框多余 </div> 导致保存按钮失效
- 更新 .gitignore 排除虚拟环境文件
2026-04-08 23:26:17 +08:00

1.7 KiB
Raw Permalink Blame History

Review Notes / 审查记录

一致性检查

  • 所有文档中的组件名称、文件路径与代码库一致
  • 数据模型字段与 src/core/models.py 中的 ORM 定义匹配
  • API 路径与 Blueprint 注册的路由一致
  • 配置项与 .env.example 中的变量对应

完整性检查

已充分覆盖的区域

  • 系统架构和线程模型
  • 核心业务组件对话、工单、知识库、Agent
  • 数据模型和 ER 关系
  • REST API 接口概览
  • 外部集成飞书、LLM
  • 启动流程和关键工作流

需要补充的区域 ⚠️

区域 说明 建议
src/core/cache_manager.py 缓存策略细节未深入分析 补充 Redis 缓存键命名规范和 TTL 策略
src/core/vector_store.py 向量存储实现细节 补充 Embedding 索引结构说明
src/core/embedding_client.py Embedding 客户端接口 补充模型加载和推理流程
src/web/static/js/ 前端模块化结构 补充前端模块职责说明
src/repositories/ 数据访问层steering 中提到但未深入) 补充 Repository 模式和自动 tenant_id 过滤机制
错误处理 error_handlers.py 的统一响应格式 补充 API 错误码规范
部署配置 Docker / Nginx 配置细节 补充 nginx.conf 和 docker-compose 说明

语言支持限制

  • 代码注释和 UI 文本为中文,文档已采用中英混合风格覆盖
  • 无其他语言支持限制

建议

  1. src/repositories/ 层补充文档,说明自动 tenant_id 过滤的实现
  2. 补充前端 JS 模块的职责划分文档
  3. 考虑为 API 添加 OpenAPI/Swagger 规范
  4. 补充部署相关的 Docker 和 Nginx 配置说明