执行摘要
本 PR 按 issue #2361 的 Resources-tab 计划重构文档站导航:FAQ 从 Resources 中拆出成为顶级 tab,Blog 页收敛为指向 LMSYS 博客的一行链接,Subscribe 信息迁到 Resources 下的独立页面,并删除本地发布博文。纯文档变更(+20/-85、4 个文件),无代码影响,风险低。
功能与动机
issue #2361 明确三点要求:FAQ 独立为顶级 tab;博客链接到 LMSYS blog(未来 LMSYS 会有 Miles tab,当前先链整站);Subscribe 移到 Resources 下。PR body 补充:本地 Introducing Miles 发布公告已上线 LMSYS,且仓库内没有其他页面链接到它,因此删除本地副本,避免双份发布内容漂移。
实现拆解
- 调整导航配置
docs/docs.json:Resources 组内 pages 由 faq、blog/index 改为 blog/index、subscribe,并在顶层新增独立 FAQ tab。/faq 路径保持不变,已有链接不会失效。
- 精简
docs/blog/index.md:删除 description 元数据、本地博文卡片(CardGroup)和 Subscribe 区块,整页收敛为一行指向 https://www.lmsys.org/blog 的链接。
- 删除
docs/blog/introducing-miles.md(67 行本地 launch 博文):发布内容已在 LMSYS 博客且仓库内无其他引用,避免双份发布文案漂移。
- 新增
docs/subscribe.md:把原 Blog 页底部的订阅信息(GitHub releases、Twitter/X)迁移为 Resources 下的独立页面。
- 验证配套:无源码或测试改动;PR 自带 Mintlify preview 手动检查清单(顶级 tab、Resources 侧边栏、
/blog、/subscribe、/faq 渲染),并确认 docs.json 解析通过。
关键源码片段
docs/docs.json
本次变更的核心导航配置:FAQ 升级为顶级 tab,Resources 下新增 subscribe 页,决定整个文档站 tab 与侧边栏结构。
{
"navigation": [
// 前面 Developer Guide、Platforms 等 tab 保持不变,此处只列本次调整涉及的 tab
{
"tab": "Resources",
"groups": [
{
"group": "Resources",
"pages": [
"blog/index", // Blog 页收敛为一行指向 LMSYS 的链接
"subscribe" // 原 Blog 页底部的订阅信息迁移到独立页面
]
}
]
},
{
"tab": "FAQ", // FAQ 从 Resources 拆出,成为与 Resources 平级的顶级 tab
"groups": [
{
"group": "FAQ",
"pages": [
"faq" // 页面路径保持 /faq 不变,旧链接不失效
]
}
]
}
]
}
评论区精华
“Can we drop the description field?” —— Shi-Dong 自评,最终删除 description 元数据。
“Check out Miles blog posts on the LMSYS blog” —— 采纳为最终一行文案。
另一个 reviewer Zhichenzzz 直接 APPROVED,无其他争议或未解决疑问。
风险与影响
- 外部依赖:
/blog 现在依赖 www.lmsys.org/blog 的可用性;LMSYS 的 Miles tab 尚未开通,当前只能链到整个 blog,粒度不够细。
- 404 风险:删除
introducing-miles.md 后 /blog/introducing-miles 将 404;PR 确认仓库内无其他链接引用,但外部书签或搜索引擎流量不受控。
- 校验薄弱:导航变更只靠 Mintlify 预览手测,没有 CI 自动断言
docs.json schema 与页面存在性;且 main 上已有一个 pre-existing 顶层 quirk,后续改动需留意。
- 影响面:仅文档资源变化,不影响运行时、构建与测试;对团队而言,LMSYS Miles tab 上线后只需再改一次
docs/blog/index.md 链接。
关联脉络
本 PR 与 2366(同为 docs/docs.json 导航改动)、2225(README 精简为导航)、2373(文档指向外部上游资源)等近期待办一致,说明文档站在持续做结构收敛与外部资源指向。下一节点是 LMSYS Miles tab 上线后,把 docs/blog/index.md 的链接从整站 blog 细化到 Miles 专属 tab。
参与讨论