1 Fork 0

Files

T

LoveChengke 19c2aa07b2 feat(docs,scripts,build): 用 docfx 搭文档站并发布到 GitHub Pages，版本号收口成脚本迭代

文档站（`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`。

2026-10-06 16:27:44 +08:00

5.4 KiB

Raw Blame History

title, description

title	description
班级、学生与教师	班级账号、学生名单、班主任与协作教师，以及"谁能看什么、谁能改什么"。

班级、学生与教师

班级账号：学生端的身份

学生没有个人账号。一台教室机器用一个班级账号登录：

班级码（例如 G203） + 班级密码  →  这台机器代表"高二(3)班"

登录之后，这台机器上的「已读 / 完成 / 未交」都是代全班操作的；它看到的是本班的数据。

班级码是管理员在「班级管理」里设的（新建时自动生成，可以改成好记的）。校验时会统一按大写比对（码存大写）。

班级密码在新建班级时由 .env 的 DEFAULT_CLASS_PASSWORD 决定初始值，之后由管理员在「班级管理 → 修改班级账号」维护。

客户端没有改密码入口，这是刻意移除的：教室机器上误改班级密码会让别的机器登录不了。教师 / 管理员本人改密码在 Web 端顶栏头像菜单里。

学生

学生管理（仅管理员）→ 新建 / 导入名单。

学生记录只是名单：成绩、未交名单、叫人、已读记录都按名单记录，所以名单不全这几项就不准。

项目	说明
用户名	`^[A-Za-z0-9_.-]{3,32}$`；单个新建时自动生成
密码	没有密码概念。学生的 `passwordHash` 是空串占位，不能登录，也没有任何重置密码接口
所属班级	一个学生属于一个主班级

用学生用户名去登录会被拒。就算拿教师 / 管理员账号去试，服务端也会在密码校验之前先判角色 —— 否则"密码错(401)"和"密码对但学生账号已停用(403)"的差异会把学生账号密码变成可离线验证的预言机。

教师

能力	在哪	谁能做
新建 / 编辑 / 删除	「教师管理」	仅管理员
导入名单（xlsx/csv）	「教师管理 → 导入名单」	仅管理员
重置密码	「教师管理」（可指定新密码，留空用默认初始密码）	仅管理员
加进某个班	班级详情 → 协作教师	管理员 / 教师
换班主任	班级详情顶部「更换班主任」	仅管理员

教师录入只有管理员能做：/api/teachers 整组接口都是 requireRole('ADMIN')，教师调用返回 403。前端也只在管理员登录时显示这个菜单项。

删除教师有护栏

下面四种情况一律拒绝（409），因为删账号会级联删掉他在各班发过的内容：

他还是某个班的班主任；
名下有课程；
有班级分配（协作教师）；
发布过作业或通知。

（后两项曾经漏检，会静默删掉该教师发过的作业与通知。）

角色与可见范围

班级内的角色由「账号角色 + 与该班级的关系」共同决定：

角色	怎么判定	可见范围
`ADMIN` 管理员	`User.role = ADMIN`	全部班级
班主任 `HEAD`	`Class.teacherId === 当前用户`	本班
科任老师 `SUBJECT`	`ClassTeacher` 里有当前用户	被分配的班级
学生 `STUDENT`	`User.classId` / 班级账号	自己的班级（只读业务数据）

权限矩阵（摘要）

操作	管理员	班主任	科任老师
班级创建 / 修改 / 删除	✅	❌	❌
分配班主任与科任老师	✅	❌	❌
学生名单管理（增删 / 导入）	✅	❌	❌
教师录入（新建 / 导入 / 改密码）	✅	❌	❌
数据库管理（备份 / 导入导出 / 切换）	✅	❌	❌
课表管理（增删改 / 导入）	✅	✅（仅本班）	❌
布置作业	✅	✅	✅
叫人	✅	✅	✅
发布通知	✅	✅	✅
成绩录入 / 修改 / 导入（仅本班）	✅	✅（仅本班）	❌
维护班级密码	✅	❌	❌

完整矩阵与实现见角色与权限。

学期周数

每个班有自己的学期周数（Class.termWeeks，默认 20，上限 30），只有管理员能改。它决定"现在是第几教学周"，见课表。

5.4 KiB Raw Blame History Unescape Escape