Prhub

#2523 docs: delete the FAQ page

原始 PR 作者 Shi-Dong 合并时间 2026-08-15 13:34 文件变更 4 提交数 7 评论 3 代码增减 +2 / -147

执行摘要

删除 FAQ 页面,清理导航并更新入站链接

PR body 说明要“Removes the FAQ page from the docs entirely”,并指出该页面早期只做内容审计范围已超支。reviewer Zhichenzzz 明确表示“this FAQ looks like very out of date and not ver constructive suggestions”,建议改为在 Resources 中引导用户去 GitHub issue。作者采纳了整体删除的方向,并清除了所有入站引用。

值得快速浏览。这个 PR 是文档清理的典型范例:先尝试局部修正、再基于 review 反馈转为整体删除,并同步清理入站链接。对维护文档的团队有参考价值,尤其是如何处理“过时且误导”的页面、如何与导航配置保持一致。

讨论亮点

核心讨论围绕 FAQ 的去留和链接去向展开:

  • Zhichenzzz 对 FAQ 的总体评估:在 review 中指出“this FAQ looks like very out of date and not ver constructive suggestions”,建议把页面改成 Resources 下的一个小节,引导用户到 GitHub issue 开问题。作者最后选择了完全删除,而不是保留简化版。
  • Zhichenzzz 对 Slack 频道存在性的质疑:在 quick-start.md 的 diff 上提问“do we have Miles channel in sglang slack?” 因为原 PR 第一版把链接指向 Slack 的 Miles 频道,但该频道可能并不存在。随后作者在最终提交中将链接改为 GitHub issues,绕开了这一不确定性。
  • 作者自我 review 的收敛:Shi-Dong 对 FAQ 内容的两处修改(Slack 频道措辞、SGLang FAQ 链接地址)自评“Drop this change”,说明局部修订无必要,最终走向整体删除。

实现拆解

实现步骤拆解如下:

  1. 删除页面本体:移除 docs/faq.md(139 行),内容是 14 个 Accordion 形式的常见问题,包含训练乱码、Ray 卡住、OOM、多节点失败、batch size 计算等。删除前作者曾尝试修订其中的错误建议(如不存在的 --ckpt-step),但最终认为整个页面价值不高。

  2. 更新导航配置:在 docs/docs.json 中删除了一个 FAQ 标签块,该标签下只有 faq 一个页面。移除后文档导航结构更简洁,同时需要保证 docs.json JSON 解析合法。

  3. 清理入站链接

    • docs/getting-started/installation.md:故障排查入口从 [Debugging](/developer/debug) 或 [FAQ](/faq) 收窄为仅保留 Debugging,减少重复入口。
    • docs/getting-started/quick-start.md:文末“如果你遇到问题”从指向 FAQ 改为“open an issue on GitHub”,更直接地引导用户提交反馈。
  4. 验证:通过 grep -rn "/faq" docs 确认仓库内不再有对 /faq 的引用,保证没有死链残留。

文件 模块 状态 重要度
docs/faq.md 文档页 removed 4.04
docs/docs.json 文档导航 modified 2.97
docs/getting-started/installation.md 安装页 modified 1.32
docs/getting-started/quick-start.md 快速上手 modified 1.32

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

评论区精华

FAQ 内容过时且无建设性建议 设计

reviewer Zhichenzzz 指出 FAQ 已经过时且建议不够建设性,建议将其改为 Resources 下的一个小节,引导用户到 GitHub issue。

结论:作者决定完全删除 FAQ 页面,而不是保留或重组内容。 · 已解决

SGLang Slack 频道的存在性 question

Zhichenzzz 在 quick-start.md 的 diff 上提问“do we have Miles channel in sglang slack?”,质疑是否有专门的频道。

结论:后续提交将最终链接改为 GitHub issues,避免依赖可能存在或不存在的 Slack 频道。 · 已解决

作者放弃两处局部修订 style

Shi-Dong 在 docs/faq.md 的两处修改(Slack 频道措辞、SGLang FAQ 链接)上自评“Drop this change”,认为没有必要。

结论:这两处改动被放弃,页面随后被整体删除。 · 已解决

风险与影响

主要风险点是删除内容可能影响用户自助排查:

  • docs/faq.md 中的 14 个问题虽有过时内容,但也包含一些仍有用的通用建议(如 OOM 时调 max_tokens_per_gpu、日志位置等),删除后用户需要到 Slack/Issues 求助,可能增加社区提问成本。
  • 链接改向 GitHub issues 与 Slack,但 Slack 频道存在性在 review 中已被质疑,最终 quick-start 改用 GitHub issues 而 installation 只保留 Debugging 链接,规避了该风险。
  • docs.json 是导航配置,若删除标签后 JSON 格式错误会导致文档站点构建失败,但 PR 自述已确认解析正常。
  • 无自动化测试覆盖纯文档变更,依赖人工检查 grep 和 Mintlify 预览。

对用户:FAQ 页不再可见,故障排查路径变为 Debugging 页面 + GitHub issues/Slack,引导更聚焦且绕开过时信息。对文档团队:减少了需维护的页面数量和导航复杂度,docs.json 更精简。对仓库:改动范围仅限 docs 目录,不影响任何运行时代码或依赖,影响面低。

删除内容影响用户排查路径 导航配置需人工验证 无自动化测试覆盖

关联 Issue

未识别关联 Issue

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

完整报告

参与讨论