anonsaber
0ffe19cfe6
docs: README 中英双版补「保持 debug 关闭」的运维规则
...
用户结论：SAF-DEBUG-ALLOWLIST 那项不需要修，只要控制好不打开 debug 即可；
这条运维规则应写进面向用户的 README，不能只留在 deployment.md。
README.md / README.zh-CN.md（1:1）在既有「远程联调面」段各补两句：
- 唯一的运行规则就是不要打开——启动命令不加 `--debug`、环境变量不设
`DEBUG_TOKEN`，缺任意一个 `/debug/*` 就不存在。
- 若确需为一次排障临时开启，先配好 chat 白名单——白名单为空时
`POST /debug/notify` 的测试发送不受限到任何 chat。
无新链接、无新锚点、无表格，纯散文；`docs/deployment.md` §2.1 引用沿用段内
既有引用。代码未改动，gate 基线不变（afa6cec，49/0/1）。
文档校验器 0 error（exit 0）。
2026-09-28 17:18:59 +08:00
anonsaber
399b26918e
docs: ④ /debug/* 配套文档 + 全量锚点重锚 + AGENTS v3 版本基线（01a0e6de）
...
## 锚点重锚（afa6cec 之后）
④ 对 notify.rs 的编辑使一批 `notify.rs:N` 引用整体失效。全量重扫 8 个 md、
165 个 src 锚点，0 硬错误（越界 / 区间全空 / 单行指空行三类全查）。修正要点：
- reference.md（30+ 处）：dedup/committed/inflight/ratelimit 键调用点、
error_response 320-328、error_response_with_id 1087-1093、readiness 161、
router 1275 + routes 1304-1318、worker 330、main.rs 40/50/34/78-81、
NoopWorker 由 notify.rs 更正为 worker.rs:142-144、
PROBE_TIMEOUT 73 与 tokio::join! 147、state.rs 639。
- deployment.md：149-152→227-230、159/172→239/252、index.js 40-55→45-60。
- retired.md：704→717、887-890→897-900、326→330、873→884。
- roadmap.md：95→175；design.md：main.rs 109→128。
- cloudflare-worker 侧 4 处 stale：ROUTE_METHODS 45-60、404 77-78、
405 80-83、503 85-93。
## /debug/* 文档
- deployment.md 新增 §2.1：双因子门禁、7 条路由状态码表、/debug/config 字段清单、
三条部署约束、生产建议；§5 env 表补 --debug / DEBUG_TOKEN。
- README.md / README.zh-CN.md 各加一段「远程联调面（可选，默认关闭）」，指向 §2.1。
- design.md 新增 §7.6「为何默认绝对关闭」：双因子挂载、404 而非 401
（401 会泄漏路由存在性）、无默认开启回退、不在网关白名单内 fail-closed。
## 文档纠错（与任务书相反，已按源码核实）
- /debug/worker 是 GET 不是 POST（debug.rs:79）。
- /debug/config 不是「只出布尔」：明文回 jmap.{session_url,username}、
telegram.chat_id、llm.{base_url,model} 与全部 timeout/retry，
仅 5 个凭据字段出 *_configured。文档措辞改为「不含凭据，不是全脱敏」。
- 门禁位置更正：--debug 读 main.rs:99、DEBUG_TOKEN 读 main.rs:100-103、
merge 在 notify.rs:1320-1321（无 DEBUG_BASE 常量，路径为字面量）。
## AGENTS.md
- 版本基线 v3（代码 afa6cec
2026-09-28 16:20:18 +08:00
anonsaber
e502c40a9e
docs: SPA 管理凭据 trust-root 同步（README/zh-CN/reference 三处措辞 + 锚点修正）
...
承接 800d6e0（SPA 凭据改用 CONFIG_ENCRYPTION_KEY）：
- README.md §5、README.zh-CN.md §5：trust-root 段落补齐「配置密钥即管理密钥」
的事实陈述，消除「Redis ACL 密码」的残留耦合叙述。
- docs/reference.md §3 Trust root：1:1 重写为配置密钥派生路径，移除不存在的
"refresh loop" 叙述（实际为 refresh_business_config 单次调用 + guard）。
- docs/reference.md §3 锚点修正：expires_in 引用 notify.rs:700→:787
（refresh_business_config 现位于 :717，expires_in 在 :787）。
交付方：文件规划助手（任务 01a0e379）。文档校验器 0 error，负向对照 4/4。
2026-09-28 15:08:04 +08:00
anonsaber
cc645020d9
docs: /ready 端到端就绪语义同步 + 删除 Redis 错误映射虚构断言
...
两件事一批提交（全部 docs-only，无代码改动）：
① /ready 语义升级为端到端就绪（对应 commit c5bc7b8ed93358
2026-09-28 12:08:33 +08:00
anonsaber
e35cc64ce3
docs: 清理废弃/虚构条目，新增 retired.md 独立废弃记录
...
新增 docs/retired.md（114 行）作为唯一废弃/虚构条目登记处：
- 12 条未采用的路线（teloxide / feature 集 / teloxide-core 回退 /
grammers / BotError 六个未落地变体 / 速率桶+429 分支 / 多步 FSM /
模块子树拆分 / telegram_dispatch 测试 / docker healthcheck 示例）
- 原 teloxide 候选对比评估记录 + FSM 五态状态表（保留决策依据，非当前事实）
- 24 条虚构条目（文档曾写、src/ 从未有）：幽灵模块树、delivery:pending 键、
check_config_reload、PushVerification、CancellationToken、Preview、
LlmErr、四个不存在的 LLM 环境变量、llm.call span、熔断/半开设计等
- 2 条已删除文档（docs/todo.md、HANDOFF.md，后者从未进入 git 历史）
- 3 步重启流程
docs/design.md 850 → 764 行：17 处目标形态改写为可核实的当前事实。
重点：§4 压缩并指向 retired.md；§5.2 补 Channel/Notifier/MessageAdapter
三 trait 零实现；§6 树改为真实 12 文件结构；§8.1 换成真实 src/error.rs
（原目标形态 6 变体整体移至 retired.md）；§8.3 明标无 tracing/metrics/
优雅关闭；§10.0 GATE-P0 已过；§10.5 明标 notify.rs 平铺单文件；
§11.4-11.7 的 17 条 Q 收敛为一节（均已由已实现代码回答）；
§12 全节重写（LlmClient 非 AiClient、AiError 3 变体、无熔断、
无附件、无长邮件保护、read_email 实取全文送 LLM）；§12.8/§12.9 合并。
docs/reference.md：删 delivery:pending:{stream} 换真实 stalwart:{jmap,telegram}
流名；删 cloudflare-worker/src/commands.rs 论断；键锚点校正；补网关
fail-closed 无开关说明。
AGENTS.md：§6 注册 retired.md；新增 §6.3 幽灵名规则（文档出现的模块/函数/
键必须是 src/ 真实存在，要留不存在的名字必须同时登记 retired.md）；
teloxide 专属措辞通用化为「渠道层不引入第三方 Bot 框架类型」；
保留「不得声称使用未引入依赖」约束。
docs/roadmap.md：item 2/26 按真实数字重写（18 条路由 12 条经 Worker 转发，
不转发的 6 条中仅 2 条需业务直连）；决策待定补处置建议。
README / README.zh-CN 阅读表加 retired.md，保持 1:1 对等。
待决策项收敛结论：真剩 2 项（Q-DEP-A Worker 白名单、Q-DEP-B 平台选型），
均为上线时运维选择，不影响代码结构与门禁，可挂起不产生技术债。
src/、web/、cloudflare-worker/ 零改动。基线仍 45 passed / 0 failed / 1 ignored。
2026-09-27 21:53:58 +08:00
anonsaber
24cfbb45b0
docs: 重构文档体系 — README 瘦身中英对等 + 新增 reference.md 权威事实表
...
- README.md / README.zh-CN.md 瘦身至 ~100 行，五节 1:1 对等（是什么/5分钟/配置入口/安全边界/去哪读更多）
- 新增 docs/reference.md：Redis 键+TTL+写者+读者、错误 envelope+Retry-After、后端路由与网关白名单矩阵、env 三层等单一权威表（顶部 verified against ed93358）
- 新增 docs/roadmap.md 取代 docs/todo.md（只放缺口/阻塞/阶段目标/待决策）
- docs/design.md 保留架构语义，可查表改引 reference.md；修正 /search 未实现、XAUTOCLAIM 阈值矛盾、teloxide 幽灵引用等 9 处标注
- docs/deployment.md §8.1 重写，删除依赖不存在子命令/curl 的必然失败 healthcheck 示例
- AGENTS.md §6 登记 reference.md/roadmap.md + 冲突仲裁「以 reference.md 为准」+ 中英同轮同步/公共 API 变更规则
2026-09-27 18:55:38 +08:00
anonsaber
ed93358e29
feat(notify): unify /ready not-ready 503 into the error envelope
...
- GET /ready: ready -> 200 + diagnostic report (unchanged success body);
not ready -> 503 + {"error":"service_unavailable","request_id":id}
+ Retry-After: 30, consistent with the other public entry points
- drop the legacy {"status":"not_ready"} diagnostic block from the 503 body
(backward compatibility not required)
- HTTP 200/503 semantics preserved, so Uptime Kuma HTTP(s) monitors
(status-code based) keep working
- sync docs: README.md, README.zh-CN.md, docs/design.md, docs/deployment.md,
AGENTS.md, docs/todo.md
2026-09-27 13:11:29 +08:00
anonsaber
a8fad19daa
docs: default README to English, reconcile docs, drop HANDOFF
...
- README.md is now English; add README.zh-CN.md with cross-links; both versions
cover the same 40 sections and the same key facts
- correct stale docs/design.md 10.5.1 and docs/todo.md to the current code
(XAUTOCLAIM threshold, malformed-entry ACK, error envelope now done)
- replace the temporary HANDOFF.md with docs/todo.md (unfinished work + blockers)
- adjust docs/deployment.md and AGENTS.md accordingly
2026-09-27 12:56:04 +08:00
anonsaber