docs: record README verification progress
Some checks are pending
ci / test (ubuntu-latest) (push) Waiting to run
ci / test (windows-latest) (push) Waiting to run
ci / race (push) Waiting to run
ci / integration (push) Waiting to run

This commit is contained in:
youfak 2026-07-30 22:12:25 +08:00
parent 47a4974ae1
commit b533a37f85

View File

@ -19,13 +19,13 @@
- Reference: `docs/requirements/completion-audit.md`
- Test: `docs/docs_test.go`
- [ ] **Step 1: 记录文档基线**
- [x] **Step 1: 记录文档基线**
Run: `go test -count=1 -timeout 60s ./docs`
Expected: PASS证明修改前的相对链接基线有效。
- [ ] **Step 2: 写入标题、背景与三类使用方式**
- [x] **Step 2: 写入标题、背景与三类使用方式**
将旧的“设计基线、项目骨架”定位替换为以下事实:
@ -48,7 +48,7 @@ Expected: PASS证明修改前的相对链接基线有效。
- **Admin**:运维人员查询状态、启停上游、切换路由并触发严格配置重载。
```
- [ ] **Step 3: 写入能力清单与架构图**
- [x] **Step 3: 写入能力清单与架构图**
能力清单必须区分当前已落地的配置校验、Provider 获取协调、Redis 活动池、
Distribution 原子提取、Controller HTTP 入口、PostgreSQL 管理状态、Gateway
@ -73,7 +73,7 @@ flowchart LR
图后必须说明PostgreSQL 只保存管理面状态Redis 保存短 TTL 代理活动池、
协调状态和分布式短期状态Gateway 热路径只访问节点内存。
- [ ] **Step 4: 写入完成度快照**
- [x] **Step 4: 写入完成度快照**
使用固定统计日期 `2026-07-30`,展示:
@ -93,7 +93,7 @@ flowchart LR
紧邻完成度说明数量进度不等于生产就绪度100,000 QPS 是集群设计目标,
尚无代表性环境压测报告。
- [ ] **Step 5: 写入快速开始与真实入口**
- [x] **Step 5: 写入快速开始与真实入口**
快速开始只包含仓库真实可执行的命令:
@ -117,7 +117,7 @@ go run ./cmd/proxy-controller -config deploy/config/local.yaml
Admin 启用时 `PROXY_POOL_CONFIG_FINGERPRINT_KEY` 至少 32 字节。不得加入当前
不存在的 Gateway、Checker 或负载生成器启动命令。
- [ ] **Step 6: 写入配置入口、不变量、路线图与文档导航**
- [x] **Step 6: 写入配置入口、不变量、路线图与文档导航**
关键入口链接至少包括:
@ -142,7 +142,7 @@ Admin 启用时 `PROXY_POOL_CONFIG_FINGERPRINT_KEY` 至少 32 字节。不得加
文档导航分成“设计与需求”“开发与 API”“部署与运维”“审计与测试”四组。
- [ ] **Step 7: 验证 README 链接与格式**
- [x] **Step 7: 验证 README 链接与格式**
Run: `go test -count=1 -timeout 60s ./docs`
@ -160,7 +160,7 @@ Expected: 无输出,退出码为 0。
- Verify: `docs/development/implementation-plan.md`
- Verify: `docs/requirements/completion-audit.md`
- [ ] **Step 1: 验证本地配置命令**
- [x] **Step 1: 验证本地配置命令**
在当前 PowerShell 进程设置 README 中列出的本地环境变量,然后运行:
@ -170,7 +170,7 @@ go run ./deploy/tools/configcheck deploy/config/local.yaml
Expected: 配置校验成功,退出码为 0。
- [ ] **Step 2: 核对完成度与进程入口**
- [x] **Step 2: 核对完成度与进程入口**
Run: `(rg "^- \[[xX ]\]" docs/development/implementation-plan.md | Measure-Object).Count`
@ -184,12 +184,12 @@ Run: `Get-ChildItem cmd -Directory | Select-Object -ExpandProperty Name`
Expected: 仅输出 `proxy-controller`
- [ ] **Step 3: 扫描失实表述与临时标记**
- [x] **Step 3: 扫描失实表述与临时标记**
确认 README 没有把 100,000 QPS、gRPC descriptor、静态部署清单或局部 Gateway
组件表述成已经完成的生产能力,并确认不包含 Secret 实值和代理明细样例。
- [ ] **Step 4: 执行仓库质量门禁**
- [x] **Step 4: 执行仓库质量门禁**
Run: `go test -count=1 -timeout 60s ./...`