Prhub

#2326 [doc] update doc

原始 PR 作者 zhuzilin 合并时间 2026-08-25 13:32 文件变更 3 提交数 1 评论 0 代码增减 +38 / -4

执行摘要

更新 README 与 CONTRIBUTING 文档,补充代码阅读路线

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

本 PR 为纯文档更新,价值不高,但其中的“代码阅读路线”对新手有参考意义,值得新贡献者阅读,以快速把握 slime 的整体架构。

讨论亮点

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

实现拆解

  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 文档 modified 2.75
README_zh.md 文档 modified 2.75
CONTRIBUTING.md 文档 modified 1.7

分析完成后,这里会展示 LLM 生成的相对完整源码片段和详细注释。

评论区精华

没有提炼出高价值讨论线程

当前评论区没有形成足够清晰的争议点或结论,后续有更多讨论时会体现在这里。

风险与影响

纯文档修改,无代码逻辑变更,技术风险极低。潜在风险是文档与代码实际模块结构可能出现偏差,例如代码阅读路线中提到的文件路径如果未来发生重构,则可能过时。建议在后续重构时同步更新该文档。

对用户与团队的影响主要是提升可读性和入门体验。新增的代码阅读路线有助于新贡献者快速定位关键模块,降低入门成本。对系统无影响。影响范围局限在仓库文档层面,不涉及运行时行为。

纯文档变更

关联 Issue

未识别关联 Issue

当前没有检测到明确关联的 Issue 链接,后续同步到相关引用后会出现在这里。

完整报告

参与讨论