FORK / 上游项目
thuservices
清华大学校园服务和工具索引,含 MkDocs 站点。
本页记录本轮维护的改动和验证结果。完整差异与实时合并状态请查看 Pull Request ↗。
这是 Fork 仓库。保留上游目录、许可与贡献说明;安装和兼容性以上游对应版本为准。查看上游 ↗
准备环境
- python -m pip install -r requirements.txt
- 目录改名后重新安装本仓库 pre-commit 到 git rev-parse --git-path hooks/pre-commit 指定位置;先保留现有自定义检查。
使用入口
- python gen.readme.py # 输出目录到终端
- python -m mkdocs serve
目录结构与职责
- docs/ — 分类服务文档
- source-docs/ — README 模板与辅助工具(原 aux/)
- gen.readme.py — 汇总 README
- mkdocs.yml — 站点配置
本次整理
- 新增维护文档和在线文档入口,补全用途、目录、使用路径及验证边界。
- 修复 Windows 无法检出的文件/目录名,并同步相关引用。
- 同步 pre-commit、README 模板和工具文档路径;生成器显式使用 UTF-8。
- 文档改为链接本Fork的hook,并明确旧复制hook需重新安装,避免继续访问已移除aux目录。
检查结果
| 检查项 | 状态 | 证据 / 范围 |
|---|---|---|
| 仓库目录与入口盘点 | passed | 检查 Git 索引中的 38 个路径、README 和项目配置;不等于功能验收。 |
| 完整构建与端到端运行 | not_run | 辅助脚本涉及校园账号、网络或费用查询,本次不执行这些外部操作;未验证服务链接当前可用性。 |
| README 生成器 | passed | python -X utf8 gen.readme.py 运行成功,合并前后模板后同步根目录和 docs/README.md。 |
| Python AST | passed | 3 个文件通过最终解析;不导入依赖、不执行应用。 |
| JavaScript syntax | passed | 3 个文件通过最终解析;不导入依赖、不执行应用。 |
| 迁移说明与README同步 | passed | 使用python -X utf8 gen.readme.py重建两份README,二者字节一致;模板和生成结果均指向本Fork hook并包含重新安装步骤。 |
已知限制与后续工作
- 辅助脚本涉及校园账号、网络或费用查询,本次不执行这些外部操作;未验证服务链接当前可用性。