Prhub

#2225 docs: trim repo README to banner and nav links

原始 PR 作者 Shi-Dong 合并时间 2026-08-11 06:27 文件变更 1 提交数 7 评论 4 代码增减 +3 / -146

执行摘要

README 精简为 banner 与文档站导航

PR body 明确说明被移除内容已在文档站维护:The removed content ... is maintained on the documentation site: https://miles.radixark.com/docs。近期 PR 2216、2271 已把模型表等信息维护点固化到 docs 站,README 表格只会滞后,因此本 PR 把 README 转型为纯入口页,落实单一信息源策略。一个细节是:首个 commit 原本是给 README 模型表补 GLM-5/5.1/5.2,随后直接转为删表,这正是意识到双份维护不可持续的体现。

建议快速浏览,不必精读。两个值得关注的设计决策:一是仓库 README 收敛为 banner + 导航的文档治理模式,适合已有独立文档站的大型项目;二是用 7 个小 commit 拆分删内容、改导航、按评审收敛措辞,方便回溯每处删除的决策依据。若要复用,可补充 CI 链接检查来覆盖本 PR 遗留的外部链接有效性风险。

讨论亮点

评审交锋集中在 README 删减边界与链接准确性:

  • nblintao(批准者)在 README.md 第 10 行指出 Slack 徽章链接需要确认:Need to confirm if the slack channel is correct,该问题无回复,合并时链接未改动。
  • Zhichenzzz(合并者)在第 34 行询问 should we still keep this para?,最终通过第 5 个 commit 保留并微调产品定义段落。
  • Shi-Dong(作者)自我评审两条意见:Remove "Built as a powerful fork of Slime" 与 Remove everything after the proverb,分别由第 6、7 个 commit 落实,体现作者在评审中主动收窄范围。

实现拆解

  1. 重构顶部导航行:将原有 Latest Updates | Quick Start | Key Features | Documentation 的页内锚点导航替换为四个站外链接(Quick Start 指向 /docs/getting-started/quick-start,Advanced Features 指向 /docs/advanced,Developer Guide 指向 /docs/developer,Documentation 指向 /docs),使仓库首页只承担导流职能。
  2. 删除全部信息型章节:移除 Latest Updates(2026/02 参数指南、2026/01 INT4 QAT、VLM/LLM 多轮训练、Multi-Agent 协同进化、R3 路由重放、统一 FP8、Speculative Decoding 等条目)、Key Features 与 Model Support 模型表、Diverse Training Scenarios、Quick Start 安装与训练示例、Roadmap、Acknowledgements 等约 146 行内容,这些信息已在文档站维护。
  3. 保留并微调产品定义:保留 What is Miles 段落(评审中 Zhichenzzz 曾询问是否保留),按作者自评意见删除 Built as a powerful fork of Slime 继承声明,并删除格言之后的所有扩展描述,只留定位句与格言。
  4. 配套说明:无测试、配置、schema 或部署配套改动;源码预处理确认没有源码/测试联动信号,变更仅影响 README.md。
文件 模块 状态 重要度
README.md 仓库首页 modified 4.05

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

评论区精华

Slack 徽章链接指向是否正确 question

审核者 nblintao 在 README.md 第 10 行评论:Need to confirm if the slack channel is correct。该徽章指向 https://slack.sglang.ai。

结论:评论中无回复,合并时链接未改动;若 slack.sglang.ai 并非 Miles 官方频道,徽章可能存在误导。 · unresolved-when-merged

是否保留 What-is-Miles 产品段落 设计

合并者 Zhichenzzz 询问 should we still keep this para?,针对裁剪后是否删除产品描述段落的疑问。

结论:后续第 5 个 commit(keep the What-is-Miles paragraphs in the trimmed README)明确保留该段落,并对措辞做了微调。 · 已解决

删除 slime fork 继承声明 设计

作者 Shi-Dong 自我评审要求 Remove "Built as a powerful fork of Slime",让 Miles 不再以 fork 身份介绍自己。

结论:第 6 个 commit(drop the slime-fork clause from the README intro)完成删除。 · 已解决

精简到只剩格言引言 设计

作者 Shi-Dong 自我评审要求 Remove everything after "A journey of a thousand miles begins with a single rollout.",即删掉格言后的所有扩展描述。

结论:第 7 个 commit(trim the README quote to the proverb itself)完成,README 最终定格为 banner + 导航 + 一句产品定义 + 一句格言。 · 已解决

风险与影响

技术风险集中在文档入口而非代码:

  • 外部链接依赖:README 四个导航全部指向 docs 站,若 Developer Guide 等新增路径 404,GitHub 访客将失去入口,且仓库本身无 link check 机制。
  • 信息可发现性下降:模型支持、快速上手、功能列表不再直接展示,浅层访客需额外跳转;docs 站成为唯一维护点,更新不及时会造成 README 反映的信息滞后。
  • 未确认事项:Slack 徽章链接指向 slack.sglang.ai,nblintao 要求确认的评论未被处理,存在品牌归属疑问。
  • 无代码回归风险:变更仅涉及 README.md,不影响构建、测试或运行时。
  • 用户与社区:GitHub 仓库首页从信息大全变为轻量门面,获取模型支持、快速上手、路线图等信息需进入文档站。
  • 团队协作:消除 README 与 docs 双份维护的负担,与 PR 2216、2271 一起把模型表等信息的维护点固定到 docs 站;代价是 docs 成为唯一事实来源,需保证更新及时。
  • 系统影响:无代码、CI 或部署影响,风险等级低。
外部链接依赖 Slack 链接未确认 文档单一维护点

关联 Issue

未识别关联 Issue

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

完整报告

参与讨论