Fix documentation drift and add missing operational runbooks#8
Open
study8677 wants to merge 1 commit into
Open
Fix documentation drift and add missing operational runbooks#8study8677 wants to merge 1 commit into
study8677 wants to merge 1 commit into
Conversation
Correct deployment.md details (env var names, API port 3001→4000, SSH tunnel target, health check paths, 443/udp firewall rule, bind-mount setup) and flag known deviations for blocking issues DEP-02/03/04, fix factual errors in AGENTS.md (Phaser→Canvas 2D, drop nonexistent packages/ui), document 7 implemented-but-undocumented endpoints in api.md, and add operations, monitoring, incident-response, and secrets-rotation runbooks with an updated docs/README.md index. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
本 PR 只改文档，不改任何代码、配置或脚本。依据一轮针对
docs/runbooks/与infra/、.github/workflows/、实际代码的穷尽式一致性审计（24 个编号漂移点 DEP-0124 + 运维文档缺口 OPS-0107 + API 规范覆盖差异）。修复确定漂移（docs/runbooks/deployment.md）
MODEL_PROVIDER→UPSTREAM_MODE、AUTH_SECRET→BETTER_AUTH_SECRET，补FIELD_ENCRYPTION_KEY／API_KEY_PEPPER（见apps/api/src/config.ts）3001→4000；防火墙移除清单同步/health→/health/live、/health/ready--resolve方式的 Host/SNI/证书验证命令443/udp（Caddy HTTP/3）data/postgres、data/redis、data/caddy、config/caddy四个 bind-mount 目录的创建、属主、权限与首次启动校验修正事实错误（AGENTS.md）
packages/ui条目补录已实现端点（docs/specs/api.md）
新增 7.0 节，补记 7 条代码已注册但规范未列的端点（health×2、auth/session、bootstrap、plots/:id/clear、payments/orders、payments/mock complete），标注沙箱/内部范围；未实现的正式合同保持原样、不降级。
新增四份运维 Runbook（docs/runbooks/）
operations.md：Day-2 日常运维（启停、巡检、日志、BullMQ/Outbox、Redis 丢失恢复、常见故障）monitoring.md：SLI/SLO 与阈值；如实标注当前无 metrics/日志聚合设施及人工替代流程incident-response.md：SEV 分级、响应时限、升级链、沟通与复盘模板secrets-rotation.md：三个核心 Secret、数据库口令、TLS、SSH 的轮换与泄露处置docs/README.md索引同步更新。验证
pnpm exec prettier --check（全部改动文件）通过pnpm todo:check通过git diff确认 README.md 与代码零改动🤖 Generated with Claude Code