Skip to content

docs: 用户侧 README 重写与文档对齐实现(v0.1.0) - #19

Merged
pjm314159 merged 1 commit into
mainfrom
dev
Sep 27, 2026
Merged

pjm314159 merged 1 commit into
mainfrom
dev

Conversation

@pjm314159

Copy link
Copy Markdown
Owner

变更说明

把 dev 上的文档整理发版到 main:README 重写为用户侧文档,docs 全量对齐当前实现,版本号统一 v0.1.0(稳定前保持 0.x)。

  • README:功能一览 / 使用流程 / Docker Compose 部署 / 配置项速查 / 本地开发 / 已知限制
  • 2 核 2G 只表述为「本项目开发与验证所用环境」,不再作为部署基线
  • SPEC 验收标准:已实现并验证的 33 项打勾;仅「无相机环境可手动粘贴内容完成签到」未勾(前端无该入口,已在 §3.2.2 标注)
  • DESIGN 对齐实现:扫码引擎、TLS 交前置反代、路由表补 \GET /api/wechat/status\ 与鉴权白名单、\qr_update\ 回显发送者、§6 目录树、§9 双分支规范
  • CHANGELOG:消息存量 200 → 100、合并重复的 ### Changed\ 段

变更类型

  • \docs\ 文档

目标分支

  • \main\(仅发版合并,dev → main)

自查清单

关联 issue / 备注

无

- 版本号统一为 v0.1.0(SPEC/DESIGN 头部;稳定前保持 0.x)

- SPEC 验收标准:已实现并验证的 33 项打勾;仅「无相机环境可手动粘贴内容完成签到」保留未勾(前端当前无该入口,已在 §3.2.2 标注,后端 /api/sign/submit 已就绪)

- README 改为用户侧文档:功能一览、使用流程、Docker Compose 部署、配置项速查、日志/升级/卸载、已知限制

- 2 核 2G 统一表述为「本项目开发与验证所用环境」,不再作为部署基线

- DESIGN 对齐实现:扫码引擎移除 zxing、TLS 交前置反代、补 GET /api/wechat/status 与鉴权白名单、qr_update 回显发送者、§6 目录树改为实际模块、§9 改为 main+dev 双分支

- CHANGELOG:消息存量 200 改 100、合并重复的 ### Changed 段;.env.example 引用 §4 改 §6
@pjm314159
pjm314159 merged commit 0d7dcdd into main Sep 27, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant