Prhub

#48839 [docs] preserve page path in stable-docs announcement link

原始 PR 作者 sagearc 合并时间 2026-07-17 16:56 文件变更 1 提交数 2 评论 2 代码增减 +1 / -1

执行摘要

修复 stable docs 横幅链接丢失当前页面路径

文档横幅中的稳定版链接始终指向文档主页,而不是用户当前浏览的页面,导致用户需要重新导航。PR body 说明 'the banner always sends users to the stable docs homepage instead of the matching page'。

值得简单查看,了解 MkDocs 模板变量的使用方式。可作为小型修复的参考。

讨论亮点

无 review 讨论。维护者 hmellor 在 readthedocs 预览中验证了功能,并批准合并。

实现拆解

  1. 定位问题组件:横幅位于 docs/mkdocs/overrides/main.htmlannounce 块,原本硬编码链接为 https://docs.vllm.ai/en/stable/
  2. 注入当前页面路径:将链接修改为 https://docs.vllm.ai/en/stable/{{ page.url }},利用 MkDocs 模板变量 page.url 保留当前路径。
  3. 无其他配置或测试变更,改动仅 1 行。
文件 模块 状态 重要度
docs/mkdocs/overrides/main.html 文档 modified 2.14

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

评论区精华

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

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

风险与影响

风险极低。变更仅影响文档模板中的横幅链接,且已在 readthedocs 预览中验证。唯一潜在风险是 page.url 可能在不同 MkDocs 版本中行为不一致,但该变量为 MkDocs 标准内置变量。

对用户:稳定版文档链接现在会保留当前页面路径,提升导航效率。对系统:无运行时影响。对团队:无。

极小变更

关联 Issue

未识别关联 Issue

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

完整报告

参与讨论