LoveChengke
19c2aa07b2
文档站（`docs/` 就是 docfx 项目，发布在 https://lovechengke.github.io/ClassHelper/）： - 四章 + 常见问题 + 完整参考，共 44 页：快速上手（8 页）/ 应用帮助（10 页）/ 管理运维（6 页）/ 开发文档（11 页）。信息架构照 ClassIsland 文档站来： 顶栏分章、左侧章节导航、右侧本页目录、上一页 / 下一页、站内搜索、深色主题跟随系统； - 自定义模板覆盖（`templates/classhelper/`）：把 docfx modern 模板那套英文 UI 文案 （In this article / Improve this doc / Next…）换成中文，补 GitHub 入口与版本徽标， 并加一层只调排版与配色的 `public/main.css`（不动 DOM 结构）； - 站点顶栏的版本徽标取自根 `package.json`（`docs/build.mjs` 用 `--metadata` 注入）， 不在文档里写第二份 —— 否则一定漂； - 404 页单独生成：GitHub Pages 的项目页挂在 `/<仓库名>/` 子路径下，而浏览器是按**被请求的路径** 解析页面里的相对链接的，所以 `<base>` 必须钉到站点根，由 `build.mjs`（本地 `./`）与 workflow（CI 传 `/<仓库名>/`）分别注入； - 构建前清空 `_site`：docfx 只覆盖不清理，删掉或改名的页面会以旧文件留在目录里， 而 Pages 上传的是整个目录。 版本迭代（**每一次 releases，不是每一次提交**）： - 新增 `scripts/version.mjs`。这个仓库里同一个版本号散在 **10 个文件**里（5 份 `package.json`、 `deploy/package.runtime.json`、两个 compose 的镜像 tag、插件 `manifest.yml`、以及插件 C# 里的 `PluginVersion` 常量），手工改必然漏一处，而漏掉的那处**不会报错**，只在某个不常走的分支上 表现为"版本号对不上"。现在收口成两条命令：`pnpm version:check`（逐处比对，不一致 exit 1） 与 `pnpm version:bump patch|minor|major`（一次改写全部 10 处，任何一处匹配不到或匹配到多处 就直接失败退出，不做尽力而为的部分改写）； - `AGENTS.md` 新增 §4.4「版本迭代（每一次 releases，不是每一次提交）」：写清版本号落在哪 10 处、 完整发布命令序列（体检 → 验收 → `dist:all` → 哈希清单 → 推 master → `gh release create` → Linux 包由 CI 合并哈希行），以及"已发布的版本号不要复用"的理由。 其它： - `.github/workflows/docs.yml`：推 master（`docs/**` / `package.json` / workflow 自身有变）即构建并 部署到 Pages；构建带 `--check`，把 docfx 的警告当错误 —— 最常见的警告是"某个 `.md` 没被任何 `toc.yml` 引用"，那种页面有内容但没有侧边栏，属于必须修掉的疏漏； - docs 目录重组后的引用同步：`production` / `mysql` / `linux-deploy` / `winisland-design-tokens` 移到新位置后，AGENTS.md、`deploy/`、`scripts/`、客户端源码注释里的路径引用一并更新； - 文档站只发布 `docs/` 这一棵树，页面里指向树外的相对链接（`../AGENTS.md` 等）改成 GitHub 绝对 URL， 否则上线全是 404； - 图标派生清单补上文档站模板里的 `logo.png` 与 `favicon.png`（`pnpm icons` 一并生成， 仍然只有一个图形源 `build/classhelper.{png,ico}`）； - `docs/_site` 进 `.gitignore` / `.prettierignore` 与 ESLint ignores； - 根脚本补 `version:check` / `version:bump` / `docs:build` / `docs:serve` / `docs:check`。
3.6 KiB
3.6 KiB
title, description
| title | description |
|---|---|
| 开发文档 | 班级小助手的架构、接口、数据模型、权限、动效层，以及验收与发版流程。 |
开发文档
班级小助手是一个 pnpm monorepo，一份代码产出四个交付物：
| 交付物 | 位置 | 形态 |
|---|---|---|
| 后端服务 | packages/server |
Express 5 + Prisma 7 + Socket.IO，接口前缀 /api |
| Web 管理端 | packages/web-admin |
Vue 3 + Vite + Element Plus（教师 / 管理员用，PWA 可安装） |
| 桌面客户端 | packages/desktop-client |
Electron + Vue 3（学生端 / 教室机器，含灵动岛浮窗） |
| 共享契约 | packages/shared |
三端共用的类型 / 常量 / 权限 / 工具函数 |
| ClassIsland 联动插件 | packages/classisland-plugin |
.NET 8 / C#（独立于 pnpm workspace，不参与 pnpm install） |
核心链路：
教师在 Web 端发布内容
│ REST API（JWT 鉴权）
▼
后端服务（Express + Prisma）
│ 写库 + 按班级房间广播
▼
Socket.IO ──► class:{classId} 房间 ──► 学生桌面客户端实时更新 UI（含灵动岛）
ClassIsland（教室机器）──► 联动插件 ──► /api/integrations/classisland/*（设备令牌鉴权）
▲ │
└──── 老师下发的提醒 ◄──────┘
这一章有什么
| 页面 | 内容 |
|---|---|
| 架构总览 | 目录结构、技术栈、模块化设计、几条贯穿全局的约定 |
| REST API | 全部接口一览（方法 / 路径 / 权限） |
| 实时事件（Socket.IO） | 事件清单、房间规则、新增事件要改哪三处 |
| 数据模型 | 14 张表、迁移历史、跨库约定 |
| 角色与权限 | 权限矩阵与实现位置 |
| 动效层与主题 | beUI 令牌、CSS linear() 弹簧、深色主题 |
| ClassIsland 插件 | 插件契约、镜像为什么要带 startTime、部署与调试 |
| 灵动岛设计令牌 | 岛逐项的几何 / 配色 / 排版 token |
| 验收与测试 | 五套验收脚本怎么跑、哪些用例是脆弱的 |
| 版本迭代与发布 | 改版本号、出安装包、发 Release 的完整流程 |