# PR #25178 完整报告

- 仓库：`sgl-project/sglang`
- 标题：minor: docs include mac installation
- 合并时间：2026-05-18 15:49
- 原文链接：http://prhub.com.cn/sgl-project/sglang/pull/25178

---

# 执行摘要

- 一句话：在安装文档中添加 Apple Metal 链接并更新版本号
- 推荐动作：该 PR 为简单的文档维护，变更清晰，review 已通过，建议合并。关注点在于确保 `apple_metal.mdx` 页面存在，否则该链接会失效。

# 功能与动机

从变更内容看，目的是让 macOS 用户能更方便地找到适用于 Apple Metal 的安装说明，同时将与源代码版本关联的文档更新到最新发布版本，避免用户克隆到较旧的分支。

# 实现拆解

1. **在 install.mdx 中添加 Apple Metal 平台链接**：在「For other or newer platforms」列表中插入 `[Apple Metal](../hardware-platforms/apple_metal)`，与其他平台（AMD、Intel 等）并列。
2. **更新 git clone -b 版本号**：在 install.mdx 和 amd_gpu.mdx 两个文件中，将 `git clone -b v0.5.9` 改为 `git clone -b v0.5.12`，确保用户下载的代码是已发布的最新稳定版。
3. **文档迁移**：PR 初期尝试修改了旧文档目录 `docs/`，后在 reviewer 建议下将变更迁移至新文档目录 `docs_new/`，最终合并时所有改动均位于新目录。

关键文件：
- `docs_new/docs/get-started/install.mdx`（模块 文档；类别 docs；类型 documentation）: 主要入口文档，添加 Apple Metal 平台链接并更新版本号，影响用户安装指引。
- `docs_new/docs/hardware-platforms/amd_gpu.mdx`（模块 文档；类别 docs；类型 documentation）: 同步更新 git clone -b 版本号，与 install.mdx 保持一致。

关键符号：未识别


# 评论区精华

- **gemini-code-assist[bot]**建议按字母顺序排列平台列表以提高可读性，但该建议未被采纳，最终保持原有顺序。
- **zijiexia**指出文档已迁移到新位置（`docs_new`），要求作者更新对应文件，作者按照要求将改动迁移到了新目录。
- **yeahdongcn**建议在 git clone 命令中使用最新的发行版标签 v0.5.12，作者据此修改了版本号，该 review 被批准。

- 平台列表按字母排序的建议 (style): 建议未被采纳，列表保持原有顺序。
- 文档迁移到新目录 (documentation): 已按建议迁移，变更最终位于 docs_new 下。
- 使用最新发行版标签 (correctness): 已采纳，版本号更新为 v0.5.12。

# 风险与影响

- 风险：风险极低。唯一潜在风险是新增的 Apple Metal 链接可能指向尚未存在的页面（`apple_metal.mdx`），但该 PR 仅添加链接，不负责创建目标页面，若目标页面缺失用户将看到 404，但作者或后续 PR 应完成对应文档。版本号更新准确，不会引入代码问题。
- 影响：仅影响文档阅读体验，对系统功能无影响。macOS 用户能更快找到安装说明，其他用户感知不明显。团队成员可获得一个更完整、最新的文档索引。
- 风险标记：链接目标页面可能缺失

# 关联脉络

- 暂无明显关联 PR