Skip to content

Conversation

@hmellor
Copy link
Member

@hmellor hmellor commented Jul 7, 2025

Essential Elements of an Effective PR Description Checklist

  • The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
  • The test plan, such as providing test command.
  • The test results, such as pasting the results comparison before and after, or e2e results
  • (Optional) The necessary documentation update, such as updating supported_models.md and examples for a new model.

The original links will always link to the latest version of the docs, which is bad UX for users who specifically want to look at older versions of the docs.

This PR changes the internal links to relative links so that they will point to the examples from the same version as the .md file.

Purpose

Test Plan

Test Result

(Optional) Documentation Update

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@github-actions
Copy link

github-actions bot commented Jul 7, 2025

👋 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.

🚀

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.

Summary of Changes

Hello @hmellor, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on improving the user experience of the documentation by addressing an issue where internal links always pointed to the 'latest' version of a document. By converting these absolute URLs to relative paths, the documentation now correctly links to content within the same version, providing a more stable and predictable browsing experience for users viewing older documentation.

Highlights

  • Documentation Link Fix: Converted absolute internal links within docs/features/structured_outputs.md to relative paths. This change ensures that links within a specific version of the documentation point to other documents within that same version, rather than always redirecting to the 'latest' version, improving user experience for historical documentation.
  • Link Path Consistency: Observed an inconsistency in the updated links: one link (at line 160) was changed to point to a .md file, while the other two (at lines 203 and 328) retained their original .html extension. This might warrant a quick review to ensure all internal documentation links follow a consistent naming convention.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@mergify mergify bot added documentation Improvements or additions to documentation structured-output labels Jul 7, 2025
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 aims to fix internal documentation links to be relative, which is a good improvement for versioned documentation. The changes correctly update absolute URLs to relative paths. However, I've noticed some inconsistencies in the file extensions of the new links (.md vs .html), which could lead to broken links. I've also raised a question about the correctness of the new path, as it might not point to the correct example file based on the repository structure. Please see my detailed comments.

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@vllm-bot vllm-bot merged commit 923147b into vllm-project:main Jul 7, 2025
7 of 9 checks passed
@hmellor hmellor deleted the fix-internal-docs-links branch July 7, 2025 11:39
Pradyun92 pushed a commit to Pradyun92/vllm that referenced this pull request Aug 6, 2025
…roject#20563)

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
…roject#20563)

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
…roject#20563)

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Jinzhen Lin <linjinzhen@hotmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation structured-output

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants