Skip to content

[Docs] Fix hardcoded links in docs #21287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Jul 21, 2025
Merged

[Docs] Fix hardcoded links in docs #21287

merged 2 commits into from
Jul 21, 2025

Conversation

hmellor
Copy link
Member

@hmellor hmellor commented Jul 21, 2025

If left as explicit HTML links, they are almost guaranteed to break when new docs versions are released and pages are moved/renamed.

Using proper MD links:

  • Ensures that the resulting HTML link links within the same docs version
  • Allows users browsing the MD (locally or on GitHub to click through the links without leaving their preferred medium of reading the docs

@hmellor
Fix hardcoded links in docs
3b66da7 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@hmellor hmellor changed the title Fix hardcoded links in docs [Docs] Fix hardcoded links in docs Jul 21, 2025
@mergify mergify bot added the documentation Improvements or additions to documentation label Jul 21, 2025
@mergify Mergify
Copy link

mergify bot commented Jul 21, 2025

This pull request has merge conflicts that must be resolved before it can be
merged. Please rebase the PR, @hmellor.

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

@mergify mergify bot added the tool-calling label Jul 21, 2025
@mergify mergify bot added the needs-rebase label Jul 21, 2025
gemini-code-assist[bot]
gemini-code-assist bot reviewed Jul 21, 2025
View reviewed changes
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request correctly replaces hardcoded documentation links with relative markdown links, which will improve maintainability. The changes look good, and I've only found one potential issue with a link anchor that should be verified to ensure it doesn't lead to a broken link.

@hmellor
Merge branch 'main' into fix-hardcoded-links
ea271e9 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@mergify mergify bot removed the needs-rebase label Jul 21, 2025
@github-actions GitHub Actions
Copy link

👋 Hi! Thank you for contributing to the vLLM project.

💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels.

Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can either: Add ready label to the PR or enable auto-merge.

🚀

@vllm-bot vllm-bot merged commit be54a95 into vllm-project:main Jul 21, 2025
11 of 14 checks passed
@hmellor hmellor deleted the fix-hardcoded-links branch July 21, 2025 10:45
LyrisZhong pushed a commit to LyrisZhong/vllm that referenced this pull request Jul 23, 2025
@hmellor @LyrisZhong
[Docs] Fix hardcoded links in docs (vllm-project#21287)
9bc468f 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
avigny pushed a commit to avigny/vllm that referenced this pull request Jul 31, 2025
@hmellor @avigny
[Docs] Fix hardcoded links in docs (vllm-project#21287)
bcbe76b 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: avigny <47987522+avigny@users.noreply.github.com>
x22x22 pushed a commit to x22x22/vllm that referenced this pull request Aug 5, 2025
@hmellor @x22x22
[Docs] Fix hardcoded links in docs (vllm-project#21287)
d985882 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: x22x22 <wadeking@qq.com>
Pradyun92 pushed a commit to Pradyun92/vllm that referenced this pull request Aug 6, 2025
@hmellor
[Docs] Fix hardcoded links in docs (vllm-project#21287)
97452ef 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
npanpaliya pushed a commit to odh-on-pz/vllm-upstream that referenced this pull request Aug 6, 2025
@hmellor @npanpaliya
[Docs] Fix hardcoded links in docs (vllm-project#21287)
00752b1 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
jinzhen-lin pushed a commit to jinzhen-lin/vllm that referenced this pull request Aug 9, 2025
@hmellor @jinzhen-lin
[Docs] Fix hardcoded links in docs (vllm-project#21287)
601e058 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Jinzhen Lin <linjinzhen@hotmail.com>
paulpak58 pushed a commit to paulpak58/vllm that referenced this pull request Aug 13, 2025
@hmellor @paulpak58
[Docs] Fix hardcoded links in docs (vllm-project#21287)
d62aaef 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Paul Pak <paulpak58@gmail.com>
taneem-ibrahim pushed a commit to taneem-ibrahim/vllm that referenced this pull request Aug 14, 2025
@hmellor @taneem-ibrahim
[Docs] Fix hardcoded links in docs (vllm-project#21287)
6e2bdc0 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
diegocastanibm pushed a commit to diegocastanibm/vllm that referenced this pull request Aug 15, 2025
@hmellor @diegocastanibm
[Docs] Fix hardcoded links in docs (vllm-project#21287)
31f6886 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Diego-Castan <diego.castan@ibm.com>
epwalsh pushed a commit to epwalsh/vllm that referenced this pull request Aug 27, 2025
@hmellor @epwalsh
[Docs] Fix hardcoded links in docs (vllm-project#21287)
c65a19a 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
googlercolin pushed a commit to googlercolin/vllm that referenced this pull request Aug 29, 2025
@hmellor @googlercolin
[Docs] Fix hardcoded links in docs (vllm-project#21287)
9a5603c 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DarkLight1337 DarkLight1337 DarkLight1337 approved these changes

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation tool-calling
Projects
Tool Calling
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@hmellor @DarkLight1337 @vllm-bot