执行摘要
- 一句话:重构 Intern-S2-Preview cookbook 并添加交互式命令生成器
- 推荐动作:建议文档维护者阅读此 PR,了解交互式命令生成器的实现方式,可用于后续其他 cookbook 页面的统一重构。值得注意的是组件采用了 MutationObserver 监听主题切换,确保亮暗主题下样式正确。
功能与动机
PR body 指出,目的是让 Intern-S2-Preview cookbook 与 DeepSeek-V4 cookbook 的布局保持一致,提供交互式命令生成器以降低用户部署成本,并提升 Intern-S2-Preview 在侧边栏和首页卡片的展示优先级。
实现拆解
-
新增交互式命令生成器组件:创建 docs_new/src/snippets/autoregressive/intern-s2-preview-deployment.jsx,导出 InternS2PreviewDeployment 组件,包含四个选项组(Hardware Platform、Reasoning Parser、Tool Call Parser、Multi-Token Prediction),根据用户选择动态生成 sglang serve 命令,并在启用 MTP 时自动添加 SGLANG_ENABLE_SPEC_V2=1 环境变量前缀及相关 speculative 参数。
-
重构 MDX 文档:修改 docs_new/cookbook/autoregressive/InternLM/Intern-S2-Preview.mdx,按照 DeepSeek-V4 布局分为五节(Model Introduction、SGLang Installation、Model Deployment、Model Invocation),替换原本的两组静态命令块为交互式生成器导入,并添加 Docker 运行示例。
-
调整侧边栏顺序:在 docs_new/docs.json 中交换 Intern-S2-Preview 和 Intern-S1 的页面顺序,使前者排在前面。
-
更新首页卡片:在 docs_new/cookbook/autoregressive/intro.mdx 中修改 InternLM 卡片链接,从指向 Intern-S1 改为指向 Intern-S2-Preview,以突出新模型。
关键文件:
docs_new/src/snippets/autoregressive/intern-s2-preview-deployment.jsx(模块 交互组件;类别 source;类型 core-logic;符号 InternS2PreviewDeployment, getInitialState, checkDarkMode, handleRadioChange): 新增交互式命令生成器的核心组件,包含选项切换、暗色模式检测和命令生成逻辑,是整个 PR 的主要工作量所在。
docs_new/cookbook/autoregressive/InternLM/Intern-S2-Preview.mdx(模块 cookbook 文档;类别 other;类型 dependency-wiring): 重构后的文档页面,引入了交互式命令生成器,重新组织章节结构,替换了静态命令块。
docs_new/docs.json(模块 配置;类别 config;类型 configuration): 侧边栏配置,交换 Intern-S2-Preview 和 Intern-S1 的页面顺序,提升新模型的展示优先级。
docs_new/cookbook/autoregressive/intro.mdx(模块 首页卡片;类别 other;类型 core-logic): 首页 InternLM 卡片链接从 Intern-S1 改为 Intern-S2-Preview,引导用户优先关注新模型。
关键符号:InternS2PreviewDeployment, getInitialState, checkDarkMode, handleRadioChange, generateCommand
评论区精华
本次 PR 没有任何 review 评论或讨论,仅由维护者 wisclmy0611 一次性批准。
风险与影响
- 风险:本次变更为纯文档改动,不涉及运行时代码,技术风险极低。唯一潜在风险是交互式生成器中的命令参数可能随 SGLang 版本更新而过时(如 speculative 参数变更),或 Docusaurus 主题兼容性问题导致组件渲染异常。建议在相关参数变更时同步更新组件。
- 影响:影响范围限于文档读者和文档维护者。读者可以获得更友好的部署命令生成体验,减少手动拼写命令的错误。维护者需要定期检查生成器中的参数与 SGLang 实际参数保持一致。影响程度低。
- 风险标记:暂无
关联脉络
- PR #25115 [Doc]: add interns2preview in cookbook: 前序 PR,首次引入 Intern-S2-Preview 文档,本次 PR 在此基础上进行布局重构和交互增强。
参与讨论