Skip to content

Fix links in glm_image.md#3028

Merged
hsliuustc0106 merged 1 commit intovllm-project:mainfrom
oglok:patch-1
Apr 22, 2026
Merged

Fix links in glm_image.md#3028
hsliuustc0106 merged 1 commit intovllm-project:mainfrom
oglok:patch-1

Conversation

@oglok
Copy link
Copy Markdown
Contributor

@oglok oglok commented Apr 22, 2026

Purpose

Fix 3 broken relative links in docs/user_guide/examples/online_serving/glm_image.md that cause the ReadTheDocs build to fail in strict mode.

The links use ../../../../serving/ (4 levels up) when they should use ../../../serving/ (3 levels up). The file is at docs/user_guide/examples/online_serving/glm_image.md, so reaching docs/user_guide/serving/ requires going up 3 directories, not 4.

Introduced in PR #2051 ([Doc] Improve diffusion generation parameter docs for online serving, commit d96d63cb).

WARNING - Doc file 'user_guide/examples/online_serving/glm_image.md' contains a link
  '../../../../serving/diffusion_chat_api.md', but the target '../serving/diffusion_chat_api.md'
  is not found among documentation files. Did you mean '../../../serving/diffusion_chat_api.md'?

This currently blocks the ReadTheDocs CI for all open PRs.

Test Plan

python -m mkdocs build --clean --site-dir /tmp/mkdocs-output --config-file mkdocs.yml --strict

No additional test scripts needed -- this is a documentation-only fix.

Test Result

Before: Aborted with 3 warnings in strict mode!

After: 0 warnings from glm_image.md. Build completes successfully.


  • The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
  • The test plan. Please provide the test scripts & test commands.
  • The test results. Please paste the results comparison before and after, or the e2e results.
  • (Optional) The necessary documentation update.
  • (Optional) Release notes update.

Broken links in GLM documentation that make tests fail

Signed-off-by: Ricardo Noriega <rnoriega@redhat.com>
@lishunyang12 lishunyang12 enabled auto-merge (squash) April 22, 2026 12:59
@hsliuustc0106 hsliuustc0106 disabled auto-merge April 22, 2026 13:07
@hsliuustc0106 hsliuustc0106 merged commit a664e40 into vllm-project:main Apr 22, 2026
3 checks passed
qinganrice pushed a commit to qinganrice/vllm-omni that referenced this pull request Apr 23, 2026
Signed-off-by: Ricardo Noriega <rnoriega@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[CI Failure]: Doc build, docs/user_guide/examples/online_serving/glm_image.md, contains a invaild link

3 participants