chore: docs 结构整改 + compose 双目录对齐(合并重建提交)

本提交为 .git 对象库损坏后的重建提交,内容等价于原先三个本地提交
(5e2fd4c2 / 57a53c98 / 5d7e1873)的累积结果,未做任何额外改动。

一、docs 结构整改(整改 #14)
根因:重构时新结构为 untracked 文件,执行 git stash(未带 -u)未纳入,
随后 git reset 拉回 HEAD 旧 tracked 树,导致旧树复活、新旧两棵目录
树并存于 docs/,共 791 文件、双分类体系冲突。

修复动作:
- b2 同名异主题文件改名迁移保全 9 个
- C 类 39 个孤立文件按主题正确归类
- A/B1 类 222 个重复文件删除(新结构已有内容副本)
- 9 个旧独有空目录删除
- 270 处内部引用按 verified 映射改写
- 整改记录 #14 登记于 04-运维文档/部署运维

结果:docs 791 → 569 文件,顶层仅规范 8 类 + 治理文件,单树恢复。
残留:约 20 处指向从未存在文件的陈旧死链,归入独立文档卫生任务。

二、compose 双目录对齐(消除踩坑 A)
- docker-compose.yml:nginx 前端挂载全部由根目录 frontend-*/dist
  改为 src/frontend-*/dist(h5 / agent / admin / terminal)
- docker-compose.dev.yml:dev 服务 build context 与卷同步改 src/
- 效果:本地 docker compose up 不再把根目录 stale dist 挂回,
  与线上一致,分叉隐患消除(已 docker compose config 校验通过)

防复发铁律:
- 重构须提交;仓库修复须 git stash -u 或先 commit
- 新结构须 git add 并提交,避免再次 untracked 复活
- H5 改动只动 src/frontend-h5/,禁改根目录遗留 frontend-*/
This commit is contained in:
Simon
2026-08-07 22:31:32 +08:00
parent 5a77a89ab1
commit facc04aa65
573 changed files with 129347 additions and 909 deletions
@@ -0,0 +1,136 @@
# 任务说明书-126-坐席在线状态查询
> **版本**: v1.0 | **日期**: 2026-07-25
---
## 📋 基本信息
| 项目 | 内容 |
|------|------|
| **任务名称** | 坐席在线状态查询功能开发 |
| **任务ID** | #126 |
| **优先级** | 🟠P1 |
| **类型** | 功能开发 |
| **状态** | ✅ 已完成 |
| **负责人** | Simon |
| **创建日期** | 2026-07-25 |
| **计划完成日期** | 2026-07-25 |
---
## 📥 输入项来源
### 产品需求
| 来源文档 | 相关章节 | 说明 |
|----------|----------|------|
| `01-产品文档/05-用户端H5/PRD-REQ-用户-004-坐席在线状态查询-v1.0.md` | §1-§3 | 需求描述、用户故事、功能需求 |
### 技术方案
| 来源文档 | 相关章节 | 说明 |
|----------|----------|------|
| `02-技术文档/技术方案-REQ-用户-004-坐席在线状态查询.md` | §1-§2 | API接口设计、后端实现、前端实现 |
### 原型设计
| 来源文档 | 页面 | 说明 |
|----------|------|------|
| `01-产品文档/05-用户端H5/原型-REQ-用户-000-H5用户端-v2.0.html` | 标题栏区域 | 坐席在线/离线状态显示(已存在) |
### 需了解的现有代码(历史现状)
| 模块/文件 | 说明 | 需了解的内容 |
|-----------|------|-------------|
| `backend/app/api/h5.py` | H5 API 模块 | 新增接口位置、已有接口模式 |
| `frontend-h5/src/stores/conversation.ts` | Pinia 状态管理 | agentOnline 状态定义、轮询实现 |
| `frontend-h5/src/components/chat/ChatPanel.vue` | 聊天面板组件 | 标题栏状态显示逻辑 |
---
## 📤 输出成果要求
### 交付物清单
| # | 交付物 | 类型 | 说明 |
|---|--------|------|------|
| 1 | `backend/app/api/h5.py` 新增接口 | 代码 | `GET /api/h5/agents/online-status` |
| 2 | `frontend-h5/src/stores/conversation.ts` 修改 | 代码 | 实现轮询和可见性处理 |
| 3 | 技术方案文档 | 文档 | 更新验证要点 |
### 代码要求
- 遵循项目代码规范
- 所有新增代码通过 ESLint / Pylint 检查
### 文档要求
- 更新技术方案文档中的验证要点
---
## 🔧 验证方式
### 功能验证
| 验证项 | 验证方法 | 预期结果 |
|--------|----------|-----------|
| API 接口正常 | `curl http://localhost:8000/api/h5/agents/online-status` | 返回 `{"code":0,"data":{"online":true/false}}` |
| 有在线坐席时显示正确 | 手动测试(数据库有 online 坐席) | 显示"坐席在线" |
| 无在线坐席时显示正确 | 手动测试(数据库无 online 坐席) | 显示"坐席离线" |
| 轮询机制正常 | 等待30秒观察 | 状态自动刷新 |
| 页面可见性处理 | 切换浏览器标签页再切回 | 状态立即刷新 |
---
## ✅ 完成标准
### 验收条件
- [x] 后端 API 代码已完成
- [x] 前端轮询逻辑已完成
- [x] 功能验证通过
### 产出确认
- [x] 代码已提交
- [x] 接口测试通过
- [x] 页面显示验证通过
---
## 📊 工作分解
### 子任务
| 子任务 | 负责人 | 预估工时 | 状态 |
|--------|--------|----------|------|
| 后端:新增 `GET /h5/agents/online-status` 接口 | Simon | 0.5h | ✅ 完成 |
| 前端:修改 `conversation.ts` 实现轮询 | Simon | 0.5h | ✅ 完成 |
| 测试:curl 验证 + 浏览器验证 | Simon | 0.5h | ✅ 完成 |
---
## 📞 依赖与阻塞
### 前置依赖
| 依赖任务 | 依赖说明 | 状态 |
|----------|----------|------|
| REQ-用户-004 PRD | 需求已完成 | 已完成 |
| REQ-用户-004 技术方案 | 设计已完成 | 已完成 |
### 阻塞因素
| 阻塞项 | 影响范围 | 解决方案 |
|--------|----------|-----------|
| 无 | - | - |
---
## 📈 变更记录
| 日期 | 变更内容 | 变更人 | 说明 |
|------|----------|--------|------|
| 2026-07-25 | 创建任务 | Simon | 初始版本 |
| 2026-07-25 | 完成 | Simon | API 路径修正为 /h5/agents/online-statusNginx 添加 /h5/agents/ 代理;30秒轮询实现;功能验证通过 |
---
## 📎 附件
- [PRD-REQ-用户-004-坐席在线状态查询-v1.0.md](../01-产品文档/05-用户端H5/PRD-REQ-用户-004-坐席在线状态查询-v1.0.md)
- [技术方案-REQ-用户-004-坐席在线状态查询.md](../02-技术文档/技术方案-REQ-用户-004-坐席在线状态查询.md)
- [原型-REQ-用户-000-H5用户端-v2.0.html](../01-产品文档/05-用户端H5/原型-REQ-用户-000-H5用户端-v2.0.html)