Skip to content

docs: 用户侧 README 重写、文档对齐实现、验收项打勾 - #18

Merged
pjm314159 merged 1 commit into
devfrom
docs/deploy
Sep 27, 2026
Merged

pjm314159 merged 1 commit into
devfrom
docs/deploy

Conversation

@pjm314159

Copy link
Copy Markdown
Owner

变更说明

面向使用者补齐文档,并把 docs 中与当前实现不符的地方全部对齐;版本号统一为 v0.1.0(稳定前保持 0.x)。

  • README 重写为用户侧文档:功能一览 / 使用流程 / Docker Compose 部署(准备、HTTPS 与微信内扫码、改配置、日志升级卸载)/ 配置项速查 / 本地开发 / 已知限制
  • 2 核 2G 不再作为部署基线,统一表述为「本项目开发与验证所用环境」(README、SPEC §5、DESIGN §1/§8、docker-compose.yml 注释、backend/Cargo.toml、CHANGELOG)
  • SPEC 验收标准:已实现并验证的 33 项打勾;仅「无相机环境可手动粘贴内容完成签到」保留未勾(前端当前无该入口,已在 §3.2.2 标注,后端 \POST /api/sign/submit\ 已就绪)
  • DESIGN 对齐实现:扫码引擎移除 zxing(统一 BarcodeDetector → jsQR)、部署改成「只暴露 80 + TLS 交前置反代」、§3 补 \GET /api/wechat/status\ 并修正鉴权白名单与 \POST /api/rooms\ 入参、§4.2 \qr_update\ 回显发送者与 qr_ttl 钳制区间、§6 目录树改为实际模块、§7 lib/pages/components/config 更新、§9 分支规范改为 main+dev 双分支
  • CHANGELOG:消息存量 200 → 100(与后端配置一致)、合并 [Unreleased]\ 内重复的 ### Changed\ 段
  • .env.example\:WS 上限引用 §4 → §6;SPEC 会话有效期去掉「需抓包确认」的过时措辞

变更类型

  • \docs\ 文档

目标分支

  • \dev\(feature/fix 常规合并)

自查清单

  • 分支名符合规范(\docs/\ + 简短描述),基于最新 \dev\ 创建
  • 提交信息符合 Conventional Commits
  • 无代码改动(仅 \�ackend/Cargo.toml\ 一条注释),无需重跑后端检查
  • 文档已同步(SPEC/DESIGN/CHANGELOG.md)
  • 涉及资源分配的改动已确认上限约束(无改动)

关联 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 c927ec4 into dev Sep 27, 2026
2 checks passed
@pjm314159
pjm314159 deleted the docs/deploy branch September 27, 2026 15:00
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