Skip to content

Commit faeeb17

Browse files
committed
docs: 更新过期内容(版本徽章/优化文档实施状态/标准引用/归档索引)
1 parent 4b1077c commit faeeb17

9 files changed

Lines changed: 50 additions & 38 deletions

File tree

‎AGENTS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ npm run electron:build
6060

6161
# 服务端 AI 网关(在 server/ai-gateway/ 目录下)
6262
pip install -r requirements.txt
63-
python -m pytest tests/ -q # 单元测试(133 基线)
63+
python -m pytest tests/ -q # 单元测试(331 基线)
6464
python main.py # 启动 FastAPI 开发服务器
6565

6666
# 同步服务(在 server/sync-service/ 目录下)

‎README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<p align="center"><strong>你的 AI 智能学习伙伴 — 让每一分钟学习都高效有价值</strong></p>
44
<p align="center">
55
<img src="https://img.shields.io/badge/status-beta-green.svg" alt="Status" />
6-
<img src="https://img.shields.io/badge/version-v0.22.0-blue.svg" alt="Version" />
6+
<img src="https://img.shields.io/badge/version-v0.35.2-blue.svg" alt="Version" />
77
<img src="https://img.shields.io/badge/license-BUSL--1.1-blue.svg" alt="License" />
88
</p>
99
</p>
@@ -189,7 +189,7 @@ Entropydecrease/
189189
├── server/ # 后端服务(AI 网关 + 数据同步)
190190
│ ├── ai-gateway/ # Python AI 增强网关(视觉提取、语音转写、灵感整理)
191191
│ └── sync-service/ # Go 数据同步服务
192-
├── docs/ # 项目文档(phase0 ~ phase6 + 版本迭代文档)
192+
├── docs/ # 项目文档(standards/templates/adr/knowledge/versions 等)
193193
├── scripts/ # 脚本工具
194194
├── .env.example # 环境变量模板
195195
└── README.md
@@ -218,6 +218,7 @@ Entropydecrease/
218218
| **v0.9.0** | ✅ 已完成 | 笔记搜索优化 + 标签筛选 + 闪卡堆叠组件 + 多项 BUG 修复 |
219219
| **v0.10.0** | ✅ 已完成 | 主页氛围化问候 + 深海认知景深层 + 弹性翻页交互 + 启动缓冲带 + 动效优化 |
220220
| **v0.10.1** | ✅ 已完成 | 主页导航动效修复 + 弹性翻页时序优化 |
221+
| **v0.11.0 ~ v0.35.2** | ✅ 已完成 | 连续迭代:品牌迁移(课伴→熵减)、学习启动仪式、课堂助手、深潜世界(3D 视觉宪法)、MCP 学习记忆、流式 ASR/TTS、知识星座等,详见 [CHANGELOG.md](./CHANGELOG.md) 与 [docs/versions/](./docs/versions/) |
221222
| **正式上线** | 🎯 规划中 | 生产就绪版 |
222223

223224
### 🔮 未来方向

‎docs/Foresight/ai-gateway-optimization-plan.md‎

Lines changed: 30 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
> 调研日期:2026-08-01
44
> 范围:server/ai-gateway/ + client AI 调用链路
55
> 目标:识别风险、对标业界、制定可落地的优化路线图
6+
> 现状数字(2026-08 体检更新):routers 46 个、chains 45 个、客户端 handlers 26 个(本文正文数字为调研时点快照)
67
78
---
89

@@ -353,44 +354,46 @@ ai_provider_health = Gauge("ai_provider_health", "Provider health status", ["pro
353354

354355
## 五、实施路线图
355356

357+
> **实施状态更新(2026-08 全仓体检核实)**:Phase 1-2 全部落地;Phase 3 大部分落地(语义缓存 L2 未做);Phase 4 仅 OTel 落地。逐项状态见下表 ✅/⚠️/❌。另:routers 已增至 46 个、chains 45 个(本文档正文数字为调研时点快照)。
358+
356359
### Phase 1:安全加固 + 熔断(2 周)🔴
357360

358-
| 任务 | 优先级 | 工作量 | 影响面 |
359-
|------|--------|--------|--------|
360-
| 生产环境 JWT 降级模式改为拒绝启动 | P0 | 0.5d | auth.py |
361-
| Prompt 注入基础防护(正则模式) | P0 | 1d | 新增 middleware |
362-
| Provider 熔断器实现 | P0 | 2d | providers/ + fallback.py |
363-
| 流式 fallback 超时保护 | P0 | 0.5d | fallback.py |
364-
| 后台健康探活任务 | P1 | 1d | provider_bootstrap.py |
361+
| 任务 | 优先级 | 工作量 | 影响面 | 状态 |
362+
|------|--------|--------|--------|------|
363+
| 生产环境 JWT 降级模式改为拒绝启动 | P0 | 0.5d | auth.py | ✅ 已落地(auth.py:183-190 生产缺密钥 raise RuntimeError + GATEWAY_ALLOW_DEV_AUTH 开关) |
364+
| Prompt 注入基础防护(正则模式) | P0 | 1d | 新增 middleware | ✅ 已落地(middleware/prompt_guard.py,main.py:197 注册) |
365+
| Provider 熔断器实现 | P0 | 2d | providers/ + fallback.py | ✅ 已落地(providers/circuit_breaker.py) |
366+
| 流式 fallback 超时保护 | P0 | 0.5d | fallback.py | ✅ 已落地(总预算 + 首 token 探测 + tests/test_stream_fallback_timeout.py) |
367+
| 后台健康探活任务 | P1 | 1d | provider_bootstrap.py | ✅ 已落地(30s 探活循环,metrics 联动) |
365368

366369
### Phase 2:成本追踪 + 预算控制(2 周)🟡
367370

368-
| 任务 | 优先级 | 工作量 | 影响面 |
369-
|------|--------|--------|--------|
370-
| Token 成本追踪模块 | P0 | 3d | 新增 cost/ |
371-
| 预算硬限制 + 告警 | P0 | 2d | middleware + cost/ |
372-
| Prometheus 指标采集 | P1 | 2d | 新增 observability/ |
373-
| 成本报表面板 | P1 | 2d | Grafana 配置 |
371+
| 任务 | 优先级 | 工作量 | 影响面 | 状态 |
372+
|------|--------|--------|--------|------|
373+
| Token 成本追踪模块 | P0 | 3d | 新增 cost/ | ✅ 已落地(cost/tracker.py,PRICE_TABLE + Redis 管道计数) |
374+
| 预算硬限制 + 告警 | P0 | 2d | middleware + cost/ | ✅ 已落地(cost/budget.py,超限 429 + tier 分级) |
375+
| Prometheus 指标采集 | P1 | 2d | 新增 observability/ | ✅ 已落地(observability/metrics.py,prometheus_client 可选降级) |
376+
| 成本报表面板 | P1 | 2d | Grafana 配置 | ❌ 未做(Grafana 面板未配置) |
374377

375378
### Phase 3:性能优化 + 缓存升级(3 周)🟢
376379

377-
| 任务 | 优先级 | 工作量 | 影响面 |
378-
|------|--------|--------|--------|
379-
| 语义缓存(L2)实现 | P1 | 4d | cache/ |
380-
| Provider 连接池化 | P1 | 1d | providers/ |
381-
| 请求并发控制(Semaphore) | P1 | 1d | main.py |
382-
| 模型级联策略 | P2 | 3d | config/ + chains/ |
383-
| 响应压缩中间件 | P2 | 0.5d | main.py |
380+
| 任务 | 优先级 | 工作量 | 影响面 | 状态 |
381+
|------|--------|--------|--------|------|
382+
| 语义缓存(L2)实现 | P1 | 4d | cache/ | ❌ 未落地(cache/ 仍为精确 prompt hash L1) |
383+
| Provider 连接池化 | P1 | 1d | providers/ | ✅ 已落地(httpx 连接池 + Key 池化 config/key_pool.py) |
384+
| 请求并发控制(Semaphore) | P1 | 1d | main.py | ✅ 已落地(main.py:94-99 双信号量 20/3) |
385+
| 模型级联策略 | P2 | 3d | config/ + chains/ | ✅ 已落地(TIER_MODEL_ACCESS + feature 分组 fallback 链) |
386+
| 响应压缩中间件 | P2 | 0.5d | main.py | ✅ 已落地(GZipMiddleware minimum_size=500) |
384387

385388
### Phase 4:可观测性 + 未来扩展(3 周)🔵
386389

387-
| 任务 | 优先级 | 工作量 | 影响面 |
388-
|------|--------|--------|--------|
389-
| OpenTelemetry 全链路追踪 | P2 | 3d | 全局 |
390-
| 生产流量 → 评估数据集管道 | P2 | 4d | 新增 eval/ |
391-
| 虚拟 Key 签发系统 | P2 | 3d | middleware/ |
392-
| Agent 范式支持预研 | P3 | 5d | 架构设计 |
393-
| 向量数据库集成预研 | P3 | 3d | 架构设计 |
390+
| 任务 | 优先级 | 工作量 | 影响面 | 状态 |
391+
|------|--------|--------|--------|------|
392+
| OpenTelemetry 全链路追踪 | P2 | 3d | 全局 | ✅ 已落地(observability/tracing.py,OTEL 可选 no-op 降级) |
393+
| 生产流量 → 评估数据集管道 | P2 | 4d | 新增 eval/ | ❌ 未实施 |
394+
| 虚拟 Key 签发系统 | P2 | 3d | middleware/ | ⚠️ 半落地(middleware/virtual_key.py 预实现,路由层未接入) |
395+
| Agent 范式支持预研 | P3 | 5d | 架构设计 | ❌ 未实施(保持规划状态) |
396+
| 向量数据库集成预研 | P3 | 3d | 架构设计 | ❌ 未实施(保持规划状态) |
394397

395398
---
396399

‎docs/Foresight/classroom-assistant-optimization-roadmap.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
> 范围:课堂助手 P0 止血(2-4 周)→ P1 核心体验(1-2 月)→ P2 差异化增强(季度级)
77
> 工作区根目录以 `<root>` 代指 `d:\Program own\aicode\work space\Entropydecrease\`,涉及文件路径均相对该根目录
88
9+
> **实施状态更新(2026-08 全仓体检核实)**:P0-1~P0-6 已全部落地(v0.35.0,错误四分类/降级提示/启动记忆/健康检查阻断/应用内确认/ASR 丢弃提示,见 CHANGELOG v0.35.0「classroom: P0 止血」);P1-3 热词/替换词表已落地(v0.35.0「热词/替换词表与本地持久化」);P1-1 问答、P1-2 时间轴、P1-4 书面化、P2 各项仍为待实施规划。
10+
911
---
1012

1113
## 一、总体目标与原则

‎docs/archive/2026-08-10/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
# 2026-08-10 归档索引
22

33
> 基线归档(机制启动日,无昨日债务需整理)
4+
> 补充归档(2026-08 全仓体检):docs 根目录散落的 5 份历史审计报告移入本夹
45
56
## 归档内容
67
- 实施文档:performance-optimization-batch.md(性能优化三批次)/ notes-innovation.md(笔记创新)/ biolum-color-system.md(生物发光色彩)
78
- 已实施计划:2026-08-08-biolum-color-material-design.md / 2026-08-08-biolum-color-material-implementation.md
89
- 机制文档:2026-08-10-doc-archive-tech-debt-design.md(本机制 spec)与 2026-08-10-doc-archive-tech-debt.md(实施计划)
10+
- 审计报告(补充归档):audit-logic-report.md / audit-logic-report-round2.md / audit-logic-report-round3.md / audit-frontend-report.md / audit-gateway-round2.md(2026-08-04 全量逻辑审计与专项报告,历史快照)
11+
- superdesign 初始化快照(补充归档):superdesign-init/*.md(一次性初始化扫描产物,design-system.md 活文档已移入 docs/product/)
912

1013
## 技术债摘要
1114
- 未偿 1 笔:TD-001 WebGPU 渲染后端回退(P3);详见 tech-debt.md

‎docs/archive/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,4 @@ docs/archive/
6363

6464
| 归档日期 | 内容摘要 | 未偿债务 |
6565
|----------|---------|----------|
66-
| 2026-08-10 | 基线归档:性能优化/笔记创新/生物发光实施文档 + biolum 设计实施计划 + 本机制 spec | 1(TD-001) |
66+
| 2026-08-10 | 基线归档:性能优化/笔记创新/生物发光实施文档 + biolum 设计实施计划 + 本机制 spec;补充归档:5 份历史审计报告 + superdesign-init 快照 | 1(TD-001) |

‎docs/knowledge/solutions/2026-08-performance-analysis-optimization-roadmap.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,14 @@
3535

3636
### 剩余增量项(非阻塞,可后续推进)
3737

38+
> 更新(2026-08 全仓体检核实):P1-5 页面级 selector 已全部拆细(PomodoroPage/NotesPage/StudySessionPage/InspirationPage/useSocraticFlow/FeynmanPage 均为字段级订阅);P2-14 存量迁移已实现(database.ts v20 upgrade 遍历 windowCaptures 内嵌 segments 物理搬迁至独立表);P2-10 blob 迁移仍未做(维持可选)。剩余真增量项如下:
39+
3840
| 项 | 说明 |
3941
|----|------|
40-
| P1-5 其余页面 | 番茄钟已 memo 化(P3-19);闪卡/笔记/灵感页面的 `useShallow(s => s)` 整 store 订阅已用浅比较缓解,进一步拆细粒度 selector 需逐组件分析字段使用,增量推进 |
41-
| P2-10 blob 迁移(可选) | 本轮已落地压缩+懒加载的安全子集;完整的 base64→blob 引用迁移(影响同步/搜索/渲染 + 数据迁移)仍为高风险可选项,视后续存储压力再评估 |
42-
| P2-14 存量迁移(可选) | 本轮采用加法式(新表 + 旧数据回退,无迁移);如需将旧会话内嵌 segments 物理搬迁至独立表以彻底瘦身,可后续加 v20 upgrade 迁移 |
42+
| P1-5 残余 5 处 | SoundSettings/TagEditPopover/InspirationCard/AISortPanel/useNoteAI 仍为整 store `useShallow(s => s)`(小组件),可增量拆字段 |
43+
| P1-5 反模式 1 处 | NoteTagFilter selector 内调用返回新数组的 action(getAllTags),浅比较永远失败,需改订阅 notes + useMemo 派生 |
44+
| P2-10 blob 迁移(可选) | 已落地压缩+懒加载的安全子集;完整的 base64→blob 引用迁移(影响同步/搜索/渲染 + 数据迁移)仍为高风险可选项,视后续存储压力再评估 |
45+
| P2-14 存量迁移 | ✅ 已实现(database.ts v20 upgrade),本项关闭 |
4346

4447
---
4548

‎docs/standards/documentation.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -176,10 +176,10 @@
176176
| 输出物 | 格式 | 存放位置 |
177177
|--------|------|---------|
178178
| README | Markdown | 项目/模块根目录 |
179-
| 架构文档 | Markdown + 图 | docs/architecture/ |
180-
| API 文档 | OpenAPI / Markdown | docs/api/ |
179+
| 架构文档 | Markdown + 图 | 按需创建 docs/architecture/(或并入 Foresight/) |
180+
| API 文档 | OpenAPI / Markdown | 按需创建 docs/api/(或并入对应服务文档) |
181181
| CHANGELOG | Markdown | 项目根目录 |
182-
| 操作手册 | Markdown | docs/operations/ |
182+
| 操作手册 | Markdown | 按需创建 docs/operations/(或并入 server-ops 规范) |
183183

184184
## 常见误区
185185

‎docs/standards/knowledge-management.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ knowledge/
150150
|--------|------|---------|
151151
| 知识卡片 | Markdown | knowledge/ 目录 |
152152
| 索引/标签 | Markdown | knowledge/index.md |
153-
| FAQ | Markdown | docs/faq.md |
153+
| FAQ | Markdown | 官网 FAQ(website/app/faq/)或按需创建 docs/faq.md |
154154

155155
## 常见误区
156156

0 commit comments

Comments
 (0)