From 5de0891706661d70bfe7be309ee444e10b41cb67 Mon Sep 17 00:00:00 2001 From: zijunchiang Date: Tue, 15 Sep 2026 21:33:20 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E4=BF=AE=E5=9B=9E=E8=A2=AB=E8=AF=AF?= =?UTF-8?q?=E5=8E=8B=E7=A9=BA=E6=A0=BC=E7=9A=84=20':=3D'=20=E5=86=99?= =?UTF-8?q?=E6=B3=95=EF=BC=9B=E5=A5=91=E7=BA=A6=E4=B8=8E=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E5=8E=BB=E7=9C=9F=E5=AE=9E=20MariaDB=20=E7=89=88=E6=9C=AC?= =?UTF-8?q?=E4=B8=B2?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - contracts/websocket-keypoints.md(三库同源):把上一轮空格清理误伤的 'var x:= ...' 修回 'var x := ...',保持文档内代码样例可读 - contracts/rest-api.yaml(三库同源):'如 MariaDB 10.11.19' -> '如 MariaDB 10.5+' - DSH.md / tasks/001:去掉真实部署实例版本号,改为'由部署方确认'的表述 - 重新打包 v0.2.0 验证:契约 6 项一致(三库 md5 相同)、30 条路由一致。 --- DSH.md | 2 +- contracts/rest-api.yaml | 2 +- contracts/websocket-keypoints.md | 10 +++++----- tasks/001-scaffold.md | 5 +++-- 4 files changed, 10 insertions(+), 9 deletions(-) diff --git a/DSH.md b/DSH.md index a7d382b..4f49df8 100644 --- a/DSH.md +++ b/DSH.md @@ -27,7 +27,7 @@ opendance-web ←── 本仓库 |--|--| | 后端 | NestJS 11 | | ORM | TypeORM 0.3 | -| 数据库 | **现有 MySQL 兼容实例**(当前部署为 MariaDB 10.11.19),mysql2 驱动 | +| 数据库 | **现有 MySQL 兼容实例**(含 MariaDB 10.5+,由部署方提供),mysql2 驱动 | | 管理前端 | React 18 + Vite + TypeScript | | 3D 预览 | three.js + @pixiv/three-vrm | | 多格式解析 | BVH / VMD 内置纯 TS 解析器;FBX/glTF 走可选外部 Assimp | diff --git a/contracts/rest-api.yaml b/contracts/rest-api.yaml index 44e1609..e0b9557 100644 --- a/contracts/rest-api.yaml +++ b/contracts/rest-api.yaml @@ -664,7 +664,7 @@ components: type: object properties: connected: { type: boolean } - server: { type: string, description: '如 MariaDB 10.11.19' } + server: { type: string, description: '如 MariaDB 10.5+' } database: { type: string } migrationsPending: { type: integer } diff --git a/contracts/websocket-keypoints.md b/contracts/websocket-keypoints.md index fd7cbcb..fd40f48 100644 --- a/contracts/websocket-keypoints.md +++ b/contracts/websocket-keypoints.md @@ -52,13 +52,13 @@ ws://:8765/pose ```gdscript func decode(buf: PackedByteArray) -> Dictionary: assert(buf.size() == 239) - var magic:= buf.decode_u16(0) + var magic := buf.decode_u16(0) assert(magic == 0x4F44 and buf.decode_u8(2) == 1) - var flags:= buf.decode_u8(3) - var frame_id:= buf.decode_u32(4) - var pts:= [] + var flags := buf.decode_u8(3) + var frame_id := buf.decode_u32(4) + var pts := [] for i in 33: - var o:= 8 + i * 7 + var o := 8 + i * 7 pts.append({ "x": float(buf.decode_s16(o)) / 32767.0, "y": float(buf.decode_s16(o + 2)) / 32767.0, diff --git a/tasks/001-scaffold.md b/tasks/001-scaffold.md index 875f297..3634be4 100644 --- a/tasks/001-scaffold.md +++ b/tasks/001-scaffold.md @@ -52,9 +52,10 @@ curl -s http://localhost:3000/health ``` 期望:`status=ok`、`database.connected=true`、`database.server` 形如 -`10.11.19-MariaDB-...`。 +`<版本>-MariaDB-<发行版>`(版本字符串由实例返回)。 -> **环境差异记录**:文档假设 MySQL 8.x,实际部署实例为 **MariaDB 10.11.19**。 +> **环境差异记录**:文档假设 MySQL 8.x;实际部署方提供的是 **MariaDB 10.5+** 兼容实例 +> (具体版本由部署方确认,本项目不使用 MySQL 8 专有语法)。 > 已确认 TypeORM `mysql` 驱动(mysql2)兼容,SQL 限制在两者共同子集内, > 详见 `contracts/database.md`。