执行摘要
本 PR 仅修复 vllm 文档中的两处断链:docs/benchmarking/cli.md 中的 timeline HTML 路径和 tests/v1/ec_connector/integration/README.md 中指向分解编码器文档的路径。变更极小,风险极低,合并者可快速合并。
功能与动机
PR 作者 Ethan Feng 发现两个文档文件中的相对路径链接无法正确解析目标资源:
docs/benchmarking/cli.md 中 iframe 的 src 路径 ../../assets/... 从 docs/benchmarking/ 处向上跳两级会越过 docs/ 目录。
tests/v1/ec_connector/integration/README.md 中链接 ../../../docs/features/disagg_encoder.md 的 ../ 段数不足,会在 tests/docs/ 下解析而不是仓库根目录的 docs/。
实现拆解
-
修复 timelines 资产路径(docs/benchmarking/cli.md)
- 将 iframe 的 src 从 ../../assets/contributing/vllm_bench_serve_timeline.html 改为 ../assets/contributing/vllm_bench_serve_timeline.html。
- 减少一级父目录跳转,使得路径从 docs/benchmarking/ 正确指向 docs/assets/。
-
修复分解编码器文档链接(tests/v1/ec_connector/integration/README.md)
- 将相对路径从 ../../../docs/features/disagg_encoder.md 改为 ../../../../docs/features/disagg_encoder.md。
- 增加一级父目录跳转,使得路径从 tests/v1/ec_connector/integration/ 正确回溯到仓库根目录的 docs/。
-
CI 等待(无代码变更)
- 提交后 mypy CI 检查失败,作者确认与 PR 无关(由 test_sequence_parallel.py 中缺失的参数引起),并创建 #42197 修复测试文件。合并者等待 #42197 合并后自动合并本 PR。
修复 iframe 路径:
<!-- docs/benchmarking/cli.md -->
<!-- 修正前:路径层级过多,导致无法加载 timeline 可视化 -->
<!-- <iframe src="../../assets/contributing/vllm_bench_serve_timeline.html" ...></iframe> -->
<!-- 修正后:正确的相对路径,指向 docs/assets/contributing/ -->
<iframe src="../assets/contributing/vllm_bench_serve_timeline.html" width="100%" height="600" frameborder="0"></iframe>
修复分解编码器文档链接:
<!-- tests/v1/ec_connector/integration/README.md -->
<!-- 修正前:路径层级不足,导致在 tests/docs 下解析而不是仓库根目录 -->
<!-- [Disaggregated Encoder Feature](../../../docs/features/disagg_encoder.md) -->
<!-- 修正后:增加一级父目录,从 tests/v1/ec_connector/integration/ 回溯到仓库根目录 -->
Please refer to [Disaggregated Encoder Feature](../../../../docs/features/disagg_encoder.md) for the detailed explanation for the EPD features.
评论区精华
- 合并者
noooop 简单回复“thanks”并批准。
- 作者
chfeng-cs 在 CI 失败后主动诊断:“This mypy failure seems unrelated to this PR since only documentation changes were made. It is caused by a missing enable_prompt_embeds argument in tests/compile/correctness_e2e/test_sequence_parallel.py... I will submit a separate PR to address this test update.” 展示了良好的问题分离能力。
风险与影响
- 风险:无。纯文档路径调整,不涉及任何代码逻辑。
- 影响:使文档读者和测试开发人员能够正确访问被引用资源,消除 404 错误。
关联脉络
- 本 PR 的合并依赖于 #42197(修复
test_sequence_parallel.py 的 mypy 问题)。
- 属于 vllm 文档维护的常规清理工作,无其他功能关联。
参与讨论