Prhub

#2395 docs: drop the Platforms section and refresh the hardware list

原始 PR 作者 Zhichenzzz 合并时间 2026-08-12 07:07 文件变更 6 提交数 1 评论 0 代码增减 +22 / -250

执行摘要

删除重复的 Platforms 文档,统一硬件清单到安装页

PR body 明确说明:"Two places describing the same thing is two places to keep in sync, and they had already drifted (Platforms said B100, Installation said B100 / B200, the welcome page said something else again)." 即三个页面描述同一份硬件状态却彼此不一致,删除重复来源是为了让文档站只有一处需要维护的硬件支持说明。

可以将本 PR 作为“文档单一事实来源(SSOT)整理”的范例阅读,重点看 docs.json 中重定向配置的写法、硬件表按代际与 CI 保障级别分档的思路。无需精读被删除页面的细节;若团队仍依赖 ROCm 自建镜像或特征矩阵信息,建议后续在安装指南或高级主题中补回这些内容。

讨论亮点

该 PR 无 review 评论,唯一审核动作是 yueming-yuan 的 APPROVED(空评论)。值得记录的是 PR body 中作者自提的问题:per-GPU 特征矩阵中除 FP8 部分外(已存在于 advanced/fp8-low-precision.md),其余内容(如 R3、P2P 权重传输、Megatron CP、确定性推理支持情况)以及 ROCm 从源码构建配方(docker build -f Dockerfile.rocm_MI350-5)没有其他归宿,作者询问是否应并入安装页,最终合并时未并入。

实现拆解

  1. 删除重复页面:移除 docs/platforms/index.md(含 per-GPU 特征矩阵)、docs/platforms/nvidia.md(NVIDIA 镜像、NCCL/NVLink 排障、环境变量)和 docs/platforms/amd.md(ROCm 镜像与从源码构建配方),共约 231 行。
  2. 调整站点配置:在 docs/docs.json 中删除 "Platforms" 导航 tab,并在 redirects 数组新增三个永久重定向,将 /platforms/index、/platforms/nvidia、/platforms/amd 统一指向 /getting-started/installation,保证旧书签与站外链接不失效。
  3. 刷新首页硬件列表:docs/index.md 的 Supported hardware 段落中,NVIDIA 行移除不受支持的 B100、补入 B300;首段“Verified on multiple hardware generations”同步补充 A100;原指向 /platforms/index 的链接改为指向安装指南的 #hardware-requirements 锚点。
  4. 收口安装页硬件表:docs/getting-started/installation.md 中指向 /platforms/index 的链接改为本页自引用锚点,并将硬件状态表按代际重排:GB300/GB200/B300/B200 为 Production,H200/H100 为 Production (CI guarded),A100 保持 Supported,AMD 行不变,使该表成为全站权威来源。
  5. 链接与配置校验:PR 自述 docs.json 可解析、79 个导航条目全部解析到文件、所有重定向目标存在、两个 #hardware-requirements 锚点有效、无死链。
文件 模块 状态 重要度
docs/docs.json 导航配置 modified 4.26
docs/platforms/index.md 硬件文档 removed 3.87
docs/platforms/nvidia.md NVIDIA 说明 removed 4.47
docs/platforms/amd.md AMD 说明 removed 4.3
docs/index.md 文档首页 modified 2.07
docs/getting-started/installation.md 安装指南 modified 2.42

关键源码片段

docs/docs.json configuration

站点导航与重定向的核心配置:删除 Platforms tab,并新增三个永久重定向,是本次文档目录结构调整的契约所在。

// 节选 docs/docs.json 的 redirects 数组(为便于阅读添加注释,实际文件为严格 JSON 不含注释)
{
  "redirects": [
    // 既有重定向:DeepSeek V3 页面替换为 V3.2 时遗留
    { "source": "/models/deepseek/deepseek", "destination": "/models/deepseek/deepseek-v3-2", "permanent": true },    // 本次新增:旧 Platforms 三个路径统一指向安装指南,保证站外链接与旧书签不失效
    { "source": "/platforms/index", "destination": "/getting-started/installation", "permanent": true },
    { "source": "/platforms/nvidia", "destination": "/getting-started/installation", "permanent": true },
    { "source": "/platforms/amd", "destination": "/getting-started/installation", "permanent": true }
  ]
}

重定向的语义:被删除页面不再有独立内容,统一收敛到安装指南;permanent 设为 true 表明这是长期结构变化而非临时迁移。

评论区精华

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

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

风险与影响

  1. 内容丢失风险:docs/platforms/index.md 的 per-GPU 特征矩阵(BF16/FP8 GEMM/INT4 QAT/推测解码等)除 FP8 外未迁移到任何页面;amd.md 的 ROCm 从源码构建配方(Dockerfile.rocm_MI350-5)也被直接删除,依赖该配方自建镜像的 AMD 用户将失去指引。
  2. 重定向依赖:三个旧路径全部依赖 docs/docs.json 的 redirects 配置,若发布时配置解析失败或未生效,外部链接会直接 404;PR 虽声称已校验,但没有 CI 或测试证据。
  3. 残留双源漂移:硬件支持状态在 docs/index.md 和 docs/getting-started/installation.md 仍各有一份,数目虽从三个减到两个,但未来仍可能再次漂移。

对用户:文档站点导航减少一个 tab,硬件支持与容器镜像信息统一在安装指南查看,旧书签与站外 /platforms/* 链接依赖永久重定向继续可用。对系统:纯文档变更,不涉及代码、CI、镜像或运行逻辑,风险面限于文档站点本身。对团队:文档维护点减少一处,信息权威来源收敛到 installation.md,但被删除内容若确有外部依赖,需要靠重定向与后续补充来兜底。

删除内容无替代归宿 重定向依赖配置正确性 内容存在外部链接依赖

关联 Issue

未识别关联 Issue

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

完整报告

参与讨论