Prhub

#23001 Add new Mintlify documentation site (docs_new/)

原始 PR 作者 wisclmy0611 合并时间 2026-04-21 06:10 文件变更 330 提交数 150 评论 6 代码增减 +100371 / -0

执行摘要

将独立文档仓库迁移至主仓库,新增 Mintlify 文档站点。

迁移和整合 SGLang 文档从独立的 sgl-docssgl-cookbook 仓库到主 sglang 仓库的 docs_new/。这为所有 SGLang 文档提供了单一真实来源,由 Mintlify 驱动,并通过消除跨仓库同步简化了维护工作流程。(引用 PR body)

该 PR 值得快速浏览以了解新文档结构和交互式组件设计,但无需深入代码分析。建议关注 docs_new/ 目录的组织方式、CI 集成以及如何利用 Mintlify 提升文档可维护性。

讨论亮点

review 中仅有三个微小修复建议:

  • zijiexia 在 docs_new/cookbook/diffusion/intro.mdx 中指出 broken link 并建议修复,结论是链接已修复。
  • docs_new/cookbook/autoregressive/Qwen/Qwen3.5.mdxGLM-5.mdx 中,指出警告信息渲染问题,建议添加正确格式的 <Warning> 组件,结论是已修复。
    无争议讨论,所有建议均被采纳,状态为 resolved。

实现拆解

  1. 创建目录结构:添加 docs_new/ 目录,包含子目录如 docs、cookbook、snippets、cards 等,用于组织文档内容。关键文件包括 docs_new/docs.json(导航配置)和 docs_new/src/ 下的源码文件。
  2. 迁移文档内容:将原有文档迁移到 docs_new/,涵盖 Getting Started(如安装、快速入门)、模型文档(LLM、VLM、Diffusion 等,如 DeepSeek、Qwen、GLM)、硬件平台(NVIDIA GPUs、AMD GPUs、Ascend NPU 等)、开发者指南和 Cookbook 示例。
  3. 集成交互式组件:在 docs_new/src/snippets/autoregressive/ 下添加 JSX 文件,如 deepseek-r1-advanced-deployment.jsxdeepseek-r1-basic-deployment.jsx。这些 React 组件提供交互式部署命令生成器,基于用户选择(硬件、量化、场景等)动态生成 SGLang 启动命令。关键符号包括 generateCommandgetInitialState 等。
  4. 配置 CI 工作流:添加 GitHub Actions 工作流(如 .github/workflows/ 下的文件),用于定期同步 LMSYS 博客卡片,确保文档内容更新。
  5. 无代码或测试变更:所有改动仅限于 docs_new/ 目录,不修改现有源代码、测试或配置,因此无需配套测试。
文件 模块 状态 重要度
docs_new/src/snippets/autoregressive/deepseek-r1-advanced-deployment.jsx 文档片段 added 8.78
docs_new/src/snippets/autoregressive/deepseek-r1-basic-deployment.jsx 文档片段 added 8.5
docs_new/cookbook/autoregressive/Qwen/Qwen3.5.mdx Cookbook added 5.0

关键符号

DeepSeekR1AdvancedDeployment generateCommand getInitialState checkDarkMode

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

评论区精华

修复 broken link documentation

zijiexia 在 `docs_new/cookbook/diffusion/intro.mdx` 中指出链接错误,建议将 `href` 修复为 `/cookbook/diffusion/MOVA/MOVA`。

结论:建议被采纳,链接已修复。 · 已解决

警告信息渲染问题 documentation

zijiexia 在 `docs_new/cookbook/autoregressive/Qwen/Qwen3.5.mdx` 和 `GLM-5.mdx` 中指出 `<Warning>` 组件未正确渲染,建议添加完整格式的警告信息。

结论:建议被采纳,警告信息已修复为正确格式。 · 已解决

风险与影响

风险较低,主要集中在文档层面:

  • broken links:由于迁移内容庞大,可能存在未发现的链接错误(如 review 中指出的)。
  • 渲染问题:Mintlify 文档站点可能因格式问题导致内容显示异常。
  • 内容过时:文档与实际代码行为可能脱节,需定期同步更新。
    无回归、性能、安全或兼容性风险,因为不涉及代码变更。

对用户:提供统一、易于访问的文档站点,提升学习曲线和使用体验。对系统:无影响,纯文档变更不改变代码行为。对团队:简化维护流程,减少跨仓库同步开销,但需适应新文档结构。

broken links 内容过时 渲染问题

关联 Issue

未识别关联 Issue

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

完整报告

参与讨论