执行摘要
- 一句话:修复 stable docs 横幅链接丢失当前页面路径
- 推荐动作:值得简单查看,了解 MkDocs 模板变量的使用方式。可作为小型修复的参考。
功能与动机
文档横幅中的稳定版链接始终指向文档主页,而不是用户当前浏览的页面,导致用户需要重新导航。PR body 说明 'the banner always sends users to the stable docs homepage instead of the matching page'。
实现拆解
- 定位问题组件:横幅位于
docs/mkdocs/overrides/main.html 的 announce 块,原本硬编码链接为 https://docs.vllm.ai/en/stable/。
- 注入当前页面路径:将链接修改为
https://docs.vllm.ai/en/stable/{{ page.url }},利用 MkDocs 模板变量 page.url 保留当前路径。
- 无其他配置或测试变更,改动仅 1 行。
关键文件:
docs/mkdocs/overrides/main.html(模块 文档;类别 other;类型 core-logic): 唯一变更文件,修改横幅链接以保留当前页面路径。
关键符号:未识别
评论区精华
无 review 讨论。维护者 hmellor 在 readthedocs 预览中验证了功能,并批准合并。
风险与影响
- 风险:风险极低。变更仅影响文档模板中的横幅链接,且已在 readthedocs 预览中验证。唯一潜在风险是
page.url 可能在不同 MkDocs 版本中行为不一致,但该变量为 MkDocs 标准内置变量。
- 影响:对用户:稳定版文档链接现在会保留当前页面路径,提升导航效率。对系统:无运行时影响。对团队:无。
- 风险标记:极小变更
关联脉络
- PR #48617 [Render] Add round trip parity test and docs for derender: 同为文档改进类 PR,涉及文档链接和导航优化。
参与讨论