# PR #2326 完整报告

- 仓库：`THUDM/slime`
- 标题：[doc] update doc
- 合并时间：2026-08-25 13:32
- 原文链接：http://prhub.com.cn/THUDM/slime/pull/2326

---

# 执行摘要

- 一句话：更新 README 与 CONTRIBUTING 文档，补充代码阅读路线
- 推荐动作：本 PR 为纯文档更新，价值不高，但其中的“代码阅读路线”对新手有参考意义，值得新贡献者阅读，以快速把握 slime 的整体架构。

# 功能与动机

随着 GLM-5.3 发布，README 中的模型列表已过时，需补充最新版本以保持文档准确性。同时，为降低新贡献者理解 slime 代码库的难度，作者新增了代码阅读路线，引导读者从训练入口出发，按需深入各模块，避免一开始淹没在细节中。

# 实现拆解

1. **更新 GLM 版本提及**：在 README.md、README_zh.md 和 CONTRIBUTING.md 中，将 GLM 模型列表从 GLM-5.2 扩展到 GLM-5.3，保持文档与现实同步。
2. **新增代码阅读路线章节**：在 README.md 和 README_zh.md 中新增“代码阅读路线”小节，用文本树状图展示从 train.py 到 slime/ray/rollout.py、slime/ray/actor_group.py 等核心模块的调用路径，并给出首次阅读建议，将 slime/utils/arguments.py 作为配置入口，提醒读者暂缓深入部署细节和权重同步实现。
3. **配套文档同步**：CONTRIBUTING.md 仅同步了版本范围的更新，无结构性变更。

由于全部为纯文档修改，不涉及测试、配置或部署配套改动。

关键文件：
- `README.md`（模块 文档；类别 docs；类型 documentation）: 更新 GLM 版本号并新增代码阅读路线章节，是英文文档的主要变更。
- `README_zh.md`（模块 文档；类别 docs；类型 documentation）: 与 README.md 对应的中文文档变更，保持中英文一致。
- `CONTRIBUTING.md`（模块 文档；类别 docs；类型 documentation）: 同步更新贡献指南中的版本范围描述。

关键符号：未识别


# 评论区精华

无 review 讨论评论，作者直接合并。

- 暂无高价值评论线程

# 风险与影响

- 风险：纯文档修改，无代码逻辑变更，技术风险极低。潜在风险是文档与代码实际模块结构可能出现偏差，例如代码阅读路线中提到的文件路径如果未来发生重构，则可能过时。建议在后续重构时同步更新该文档。
- 影响：对用户与团队的影响主要是提升可读性和入门体验。新增的代码阅读路线有助于新贡献者快速定位关键模块，降低入门成本。对系统无影响。影响范围局限在仓库文档层面，不涉及运行时行为。
- 风险标记：纯文档变更

# 关联脉络

- PR #2323 [cleanup] Refactor rollout.py: 代码阅读路线中引用了 slime/ray/rollout.py 等文件，该重构会调整 rollout 相关结构，文档需保持一致。