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.3 KiB

Raw Blame History

title, description

title	description
通知与提醒	通知的三档优先级、上课时段策略、紧急通知的二次确认、提醒弹在哪个端、已读与红点。

通知与提醒

通知是这套系统里规则最多的一项 —— 因为它要在"老师想说"和"别打断上课"之间做取舍。这一页把规则一次讲清楚。

三档优先级

优先级	学生端表现
普通	课间弹「新消息」胶囊，点击展开详情；上课时段完全不显示（窗口隐藏）并进队列，下课自动补弹
重要	同上，卡片上有优先级标签
紧急	无论是否上课都立即展开，卡片内部红色呼吸光晕 + 「紧急」角标，无需点击，45 秒后收起

紧急通知的光晕画在卡片内部（inset 阴影），因为窗口比卡片只大 2~4px，向外的阴影会被裁成硬边。

上课时段策略

「上课时段」由课表实时判定（见课表）。判定之后：

学生端行为	上课时段	课间 / 放学
普通通知	收着不弹（窗口隐藏），进待发队列	直接弹
紧急通知	立刻弹	立刻弹
任何点击	一律不响应（不会展开、也不会回缩出胶囊）	正常

ClassIsland 那一端遵守同一套规则，否则会出现"学生在客户端看不到、却在教室大屏上被打断"。

紧急通知的二次确认

上课时段发紧急通知，服务端会拦一次（409 URGENT_DURING_CLASS）：

POST /api/notifications { classId, title, content, priority: "URGENT" }
  → 409 URGENT_DURING_CLASS（响应体里带着正在上的那节课）

POST /api/notifications { …, priority: "URGENT", confirmDuringClass: true }
  → 201 发出去

Web 端在提交前会先查一次上课状态，命中就弹一个全屏二次确认：全屏遮罩 + 强警示配色，文案是"现在为上课时间段……" + 正在上的课时段 + 待发布的标题。确认按钮带 3 秒倒计时 （圆环进度），倒计时结束前点不动，防误触。

这个拦截在服务端，不是前端提醒。 绕过界面直接调接口一样会被拦 —— 这是产品行为，不是可以关掉的提示。

提醒弹在哪个端

教室机器上的客户端「设置 → 提醒」里选，选择会同步到班级记录：

选择	ClassHelper 客户端	ClassIsland
`ClassHelper 与 ClassIsland 都弹`（默认）	弹窗 + 灵动岛	全屏提醒
`只在 ClassHelper 客户端弹`	弹窗 + 灵动岛	不推送
`只在 ClassIsland 上弹`	只进通知中心（不弹窗、不上岛）	全屏提醒

这条规则任何入口都遵守，包括 ClassIsland 联动页的「下发提醒」—— 那种情况下会回一句"该班教室已设置为只在 ClassHelper 客户端显示"。

管理员与教师也可以用 PATCH /api/classes/:id/notification-channel 改，但默认由教室机器自己定。

已读、红点与删除

能力	说明
未读红点	客户端侧边栏「通知」项右上角的徽标；数字来自 `GET /notifications/unread-count`
标为已读	点开通知自动标为已读；也有「全部已读」
班级设备	教室机器的"已读"是代全班操作的（它用的是班级账号）
删除	只有教师 / 管理员能删

发布入口只有一个实现

「通知发布」页、叫人、ClassIsland 联动页的「下发提醒」三个入口， 共用同一份 ClassIsland 推送实现。所以不存在"某个页面发的通知不联动"这种事 —— 以前有过，现在是硬约定：新增发通知的入口必须复用同一份代码。

接口

方法	路径	说明
GET	`/notifications?classId=&priority=&unreadOnly=&keyword=`	列表（带已读状态）
GET	`/notifications/unread-count`	未读数
POST	`/notifications`	发布（广播 `notification:new`）
POST	`/notifications/:id/read`、`/notifications/read-all`	标记已读
DELETE	`/notifications/:id`	删除

完整清单见 REST API。

5.3 KiB Raw Blame History Unescape Escape