Prhub

#2606 update doc & readme

原始 PR 作者 Zhichenzzz 合并时间 2026-08-18 19:38 文件变更 16 提交数 5 评论 0 代码增减 +17 / -515

执行摘要

撤回未稳定的 dashboard 长文档,重定向至监控页

PR body 为空,动机完整体现在首个 commit message 中:"The dashboard still has open problems: #2581 is fixing a partition-reader race and CP/PP-sharded dumps, and #2022, #2023, #2026 and #2027 are each reworking a different part of it. A 485-line page walking through every view, plus six screenshots of a real run, documents a surface that is still moving, so parts of it are wrong as soon as any of those land." 即:在 dashboard 界面仍在快速变动时,带截图的超长教程必然过时,需要用简短的定位性说明(工具是什么、两个记录遥测的 flag、serve 命令、指向 --help)替代,避免误导用户。

值得快速阅读的文档策略 PR,适合作为"不稳定功能不写长文档"的时机管理案例。其核心价值不在删除本身,而在决策判断:当 dashboard 五个方向并行重构时,用简短定位性说明加永久重定向替代图文教程,避免文档刚上线即过时。关注点在于:dashboard 重构(尤其 #2581 的 CP/PP 分片修复)落地后,应通过后续 PR 回补详细文档,并保持 /user-guide/dashboard 重定向的长期有效性。

讨论亮点

本 PR 没有实质性技术讨论。唯一 review 来自 claude[bot] 的自动提示(该仓库配置为手动 review 模式),以及 Rockdu 的空正文 APPROVED。决策依据全部体现在 5 个 commit message 中,尤其是首个 commit 对"文档时效性 vs 功能重构速度"矛盾的说明,可视为作者自审并直接合并的产物。

实现拆解

本 PR 是纯文档整理,无源码与测试改动,按 4 个步骤拆解:

  1. 删除 dashboard 独立页面与素材:整体删除 docs/user-guide/dashboard.md(485 行),移除围绕单个 GLM-5.2 744B 真实运行展开的全部视图说明,包括 Metrics 分类语义、Compute Utilization 的阶梯结构、dump/* 指标解读、配置建议表等;同时删除 docs/assets/images/dashboard/ 下 6 张截图 PNG(compute-utilization、metrics-rollout、metrics-sglang、rollout-groups、rollout-step、sample-conversation)。这一步消除了文档与正在变动的 UI 之间的耦合。

  2. 导航调整与永久重定向:docs/docs.json 从 User Guide 导航组中移除 "user-guide/dashboard" 条目,并在 redirects 数组末尾新增 { "source": "/user-guide/dashboard", "destination": "/user-guide/monitoring", "permanent": true },确保历史书签与站内旧链接不会因页面删除而 404。

  3. 关联文档去引用:docs/user-guide/fully-async.md 删除对 dashboard 的推荐(含 Compute Utilization 视图的引导句),改为"基础指标参考"定位;docs/user-guide/monitoring.md、docs/index.md、docs/getting-started/quick-start.md、docs/developer/debug.md、docs/README.md 同步清理对 dashboard 的提及或调整描述。

  4. 文案统一与素材刷新:README.md 将导航里的 Models 改为 Supported Models(header 表格与 Getting Started 列表同步),并删除 feature 列表中的 dashboard 条目;docs/assets/images/acknowledgment.png 刷新致谢 logo 墙,延续 #2603 的素材线。

文件 模块 状态 重要度
docs/user-guide/dashboard.md 文档页面 removed 5.2
docs/docs.json 文档配置 modified 3.77
docs/user-guide/fully-async.md 文档页面 modified 2.85
README.md 项目说明 modified 2.07
docs/index.md 文档首页 modified 1.82
docs/assets/images/dashboard/metrics-rollout.png 文档图片 removed 1.77
docs/getting-started/quick-start.md 快速入门 modified 2.02
docs/assets/images/acknowledgment.png 文档图片 modified 1.53

关键源码片段

docs/docs.json configuration

文档站导航与重定向的契约文件:从 User Guide 导航移除 dashboard 条目,并新增永久重定向兜底旧链接。

// docs/docs.json —— 页面删除与导航收编的契约配置
{
  "navigation": {
    "tabs": [
      {
        "tab": "User Guide",
        "pages": [
          {
            "group": "User Guide",
            "pages": [
              "user-guide/training-backend",
              "user-guide/monitoring",
              // 此处原为 "user-guide/dashboard",已从导航移除;
              // 旧路径仍通过下方 redirects 指向 monitoring 页
              "user-guide/customization"
            ]
          }
        ]
      }
    ]
  },
  "redirects": [
    {
      "source": "/examples/openhermes-sft",
      "destination": "/models/qwen/qwen3",
      "permanent": true
    },
    {
      // 新增:删除 dashboard 独立页后,把历史链接永久指向 monitoring 页,
      // 避免外部书签与文档站内部旧链接 404
      "source": "/user-guide/dashboard",
      "destination": "/user-guide/monitoring",
      "permanent": true
    }
  ]
}

评论区精华

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

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

风险与影响

技术风险集中在文档信息链与管理层面,而非运行时:

  1. 信息缺口:删除 485 行 dashboard 教程后,用户对 Compute Utilization 视图分层、Metrics 分类语义、dump/* 指标(dump/zero_std_group_frac、dump/mixed_version_frac)等深度指引消失,仅剩 Monitoring 下的简短段落与 --help,排查性能问题时引导减弱。

  2. 链接失效依赖重定向兜底:旧路径 /user-guide/dashboard 依赖 docs.json 的 permanent 重定向,若文档站构建时未正确加载 redirects 配置,外部书签与站内残留链接会 404。

  3. 残留引用风险:fully-async.md 等仓库内文档已清理,但外部博客、Slack 记录或其他分支中可能仍散落 dashboard 链接,无法随本 PR 一并控制。

  4. 回补遗忘风险:文档收缩是临时策略,dashboard 重构(#2581 等)落地后需要重新撰写详细文档,当前没有显式 issue 跟踪该回补任务。

对用户:dashboard 使用者失去逐步视图详解,但获得更准确的引导,不再被正在变动的 UI 细节误导;基于真实运行截图的内容移除后,文档描述与最新界面不一致的问题被消除。对系统:无任何运行时影响,仅文档站导航与重定向配置变化。对团队:降低 dashboard 功能开发与文档维护之间的耦合,避免每位开发者改动视图后还需同步 485 行文档;影响范围覆盖 docs 站点 16 个文件(515 行删除、17 行新增),但程度较轻、完全可逆。

旧 URL 依赖重定向兜底 功能文档信息缺口 重构后需重建文档 纯文档但跨 16 文件

关联 Issue

未识别关联 Issue

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

完整报告

参与讨论