# PR #2225 完整报告

- 仓库：`radixark/miles`
- 标题：docs: trim repo README to banner and nav links
- 合并时间：2026-08-11 06:27
- 原文链接：http://prhub.com.cn/radixark/miles/pull/2225

---

# docs: trim repo README to banner and nav links

## 执行摘要

本 PR 将仓库根 README 从 150 余行压缩至约 10 行，只保留 banner 区、指向文档站的四个导航链接、一句产品定义与一句格言；更新动态、功能清单、模型支持表、快速上手、路线图等章节全部删除，信息维护点统一收敛到 docs 站。变更仅涉及 README.md，无源码与测试联动，属低风险的文档治理调整。

## 功能与动机

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，随后直接转为删表，这正是意识到双份维护不可持续的体现。

## 实现拆解

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 与模型支持表、Quick Start 示例、Roadmap、Acknowledgements，共约 146 行。
3. 保留并微调产品定义：保留 What is Miles 段落，删除 Built as a powerful fork of Slime 表述，并删除格言后的所有扩展描述。
4. 配套说明：无测试、配置、schema 或部署配套改动，变更仅涉及 README.md 一个文档文件。

### 以下为 head 版本 README 主体结构（banner 头部原样保留，此处展示检索到的关键行）：

```markdown
<!-- 裁剪后的 README 主体只保留三类内容：
     1) banner 头部（logo / 标语 / badges）原样保留；
     2) 导航行由页内锚点改为文档站外链，统一信息入口；
     3) 一句产品定义 + 一句格言，其余章节全部删除。 -->

[**Quick Start**](https://miles.radixark.com/docs/getting-started/quick-start) | [**Advanced Features**](https://miles.radixark.com/docs/advanced) | [**Developer Guide**](https://miles.radixark.com/docs/developer) | [**Documentation**](https://miles.radixark.com/docs)

<!-- 产品定义段落被保留（评审中 Zhichenzzz 询问过），
     但删除了 Built as a powerful fork of Slime 的继承表述。 -->

**Miles** is a high-performance, enterprise-ready reinforcement learning (RL) framework specifically optimized for **Large-Scale model Post-Training**. Miles bridges the gap between research-grade RL and production-grade reliability by integrating **SGLang** for high-throughput rollout and **Megatron-LM** for scalable training.

<!-- 格言之后的内容全部移除，引言只保留谚语本身。 -->

> *"A journey of a thousand miles begins with a single rollout."*

```

## 评论区精华

- nblintao（批准者）：Need to confirm if the slack channel is correct，针对 Slack 徽章链接提出确认需求，无回复、原样合并。
- Zhichenzzz（合并者）：should we still keep this para?，对产品定义段落去留的询问，最终保留并微调。
- Shi-Dong（作者）两条自评：删除 slime fork 声明、只保留到格言为止，均由后续 commit 落实，呈现作者主导的收敛过程。

## 风险与影响

- 外部链接依赖：四个导航均指向 docs 站，若路径失效访问者将失去入口，且缺少 CI 链接检查。
- 信息可发现性下降：README 不再直接展示模型支持与快速上手，docs 成为唯一维护点，需保证更新及时。
- 未确认事项：Slack 徽章指向 slack.sglang.ai，nblintao 的评论未被处理。
- 无代码回归风险：仅文档文件变更，不影响构建、测试或运行时。

## 关联脉络

本 PR 是文档站化趋势的收尾：PR 2216（新增 GLM-5.2 模型页并更新模型表）、PR 2271（刷新首页模型表）把模型信息维护点固化到 docs 站，本 PR 删除 README 中最后一份会过期的表格与更新动态；PR 2264 同步 docs 首页功能清单，共同构成单一信息源的文档治理闭环。