fix[Docs]: link anchor is incorrect #20309 #20315
Conversation
|
👋 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 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 🚀 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @yyzxw, 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 addresses an issue with incorrect internal documentation links. It systematically updates all references to the 'OpenAI-Compatible Server' page by changing the anchor ID from openai-compatible-server to serving-openai-compatible-server. This change ensures that users can correctly navigate to the relevant documentation sections, enhancing the overall user experience and documentation integrity.
Highlights
- Documentation Link Correction: Updated all internal documentation links that referenced the
openai-compatible-serveranchor to the newserving-openai-compatible-serveranchor. This ensures that all references correctly point to the OpenAI-Compatible Server documentation page, improving navigation and accuracy.
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
-
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
bot
added
documentation
There was a problem hiding this comment.
Code Review
This pull request effectively addresses a documentation issue by updating incorrect link anchors across multiple Markdown files. The changes consistently replace openai-compatible-server with serving-openai-compatible-server, ensuring that all references point to the correct location. This is a straightforward and necessary fix that improves the accuracy and navigability of the project's documentation.
| @@ -6,7 +6,7 @@ title: Engine Arguments | |||
| Engine arguments control the behavior of the vLLM engine. | |||
|
|
|||
| - For [offline inference][offline-inference], they are part of the arguments to [LLM][vllm.LLM] class. | |||
| - For [online serving][openai-compatible-server], they are part of the arguments to `vllm serve`. | |||
| - For [online serving][serving-openai-compatible-server], they are part of the arguments to `vllm serve`. | |||
There was a problem hiding this comment.
This change correctly updates the internal link reference to the 'OpenAI-Compatible Server' document, ensuring that the link points to the new anchor ID. This is a good fix for a broken documentation link.
| - For [online serving][serving-openai-compatible-server], they are part of the arguments to `vllm serve`. | |
| - For [online serving][openai-compatible-server], they are part of the arguments to `vllm serve`. | |
| + For [online serving][serving-openai-compatible-server], they are part of the arguments to `vllm serve`. |
| @@ -74,7 +74,7 @@ python -m vllm.entrypoints.openai.api_server --model <model> | |||
|
|
|||
| That code can be found in <gh-file:vllm/entrypoints/openai/api_server.py>. | |||
|
|
|||
| More details on the API server can be found in the [OpenAI-Compatible Server][openai-compatible-server] document. | |||
| More details on the API server can be found in the [OpenAI-Compatible Server][serving-openai-compatible-server] document. | |||
There was a problem hiding this comment.
This update fixes the broken link to the 'OpenAI-Compatible Server' document, aligning it with the new anchor ID. This improves the accuracy and navigability of the documentation.
| More details on the API server can be found in the [OpenAI-Compatible Server][serving-openai-compatible-server] document. | |
| - More details on the API server can be found in the [OpenAI-Compatible Server][openai-compatible-server] document. | |
| + More details on the API server can be found in the [OpenAI-Compatible Server][serving-openai-compatible-server] document. |
| @@ -21,7 +21,7 @@ The following parameters are supported, which must be added as extra parameters: | |||
| - `guided_grammar`: the output will follow the context free grammar. | |||
| - `structural_tag`: Follow a JSON schema within a set of specified tags within the generated text. | |||
|
|
|||
| You can see the complete list of supported parameters on the [OpenAI-Compatible Server][openai-compatible-server] page. | |||
| You can see the complete list of supported parameters on the [OpenAI-Compatible Server][serving-openai-compatible-server] page. | |||
There was a problem hiding this comment.
The link to the 'OpenAI-Compatible Server' page has been correctly updated to reflect the new anchor ID. This ensures users can access the relevant information about supported parameters.
| You can see the complete list of supported parameters on the [OpenAI-Compatible Server][serving-openai-compatible-server] page. | |
| - You can see the complete list of supported parameters on the [OpenAI-Compatible Server][openai-compatible-server] page. | |
| + You can see the complete list of supported parameters on the [OpenAI-Compatible Server][serving-openai-compatible-server] page. |
| @@ -110,7 +110,7 @@ docker run \ | |||
| ### Supported features | |||
|
|
|||
| - [Offline inference][offline-inference] | |||
| - Online serving via [OpenAI-Compatible Server][openai-compatible-server] | |||
| - Online serving via [OpenAI-Compatible Server][serving-openai-compatible-server] | |||
There was a problem hiding this comment.
This change correctly updates the link for 'Online serving via OpenAI-Compatible Server', ensuring consistency with the new anchor ID in the documentation.
| - Online serving via [OpenAI-Compatible Server][serving-openai-compatible-server] | |
| - Online serving via [OpenAI-Compatible Server][openai-compatible-server] | |
| + Online serving via [OpenAI-Compatible Server][serving-openai-compatible-server] |
| @@ -134,7 +134,7 @@ outputs = llm.chat(conversation, chat_template=custom_template) | |||
|
|
|||
| ## Online Serving | |||
|
|
|||
| Our [OpenAI-Compatible Server][openai-compatible-server] provides endpoints that correspond to the offline APIs: | |||
| Our [OpenAI-Compatible Server][serving-openai-compatible-server] provides endpoints that correspond to the offline APIs: | |||
There was a problem hiding this comment.
The link to the 'OpenAI-Compatible Server' in the 'Online Serving' section is now correctly updated, which is crucial for users looking for API endpoints.
| Our [OpenAI-Compatible Server][serving-openai-compatible-server] provides endpoints that correspond to the offline APIs: | |
| - Our [OpenAI-Compatible Server][openai-compatible-server] provides endpoints that correspond to the offline APIs: | |
| + Our [OpenAI-Compatible Server][serving-openai-compatible-server] provides endpoints that correspond to the offline APIs: |
| @@ -113,7 +113,7 @@ A code example can be found here: <gh-file:examples/offline_inference/basic/scor | |||
|
|
|||
| ## Online Serving | |||
|
|
|||
| Our [OpenAI-Compatible Server][openai-compatible-server] provides endpoints that correspond to the offline APIs: | |||
| Our [OpenAI-Compatible Server][serving-openai-compatible-server] provides endpoints that correspond to the offline APIs: | |||
There was a problem hiding this comment.
The link to the 'OpenAI-Compatible Server' for pooling models has been accurately updated, maintaining the integrity of the documentation.
| Our [OpenAI-Compatible Server][serving-openai-compatible-server] provides endpoints that correspond to the offline APIs: | |
| - Our [OpenAI-Compatible Server][openai-compatible-server] provides endpoints that correspond to the offline APIs: | |
| + Our [OpenAI-Compatible Server][serving-openai-compatible-server] provides endpoints that correspond to the offline APIs: |
docs/models/supported_models.md
Outdated
| @@ -34,7 +34,7 @@ llm.apply_model(lambda model: print(type(model))) | |||
| If it is `TransformersForCausalLM` then it means it's based on Transformers! | |||
|
|
|||
| !!! tip | |||
| You can force the use of `TransformersForCausalLM` by setting `model_impl="transformers"` for [offline-inference][offline-inference] or `--model-impl transformers` for the [openai-compatible-server][openai-compatible-server]. | |||
| You can force the use of `TransformersForCausalLM` by setting `model_impl="transformers"` for [offline-inference][offline-inference] or `--model-impl transformers` for the [serving-openai-compatible-server][openai-compatible-server]. | |||
There was a problem hiding this comment.
This update correctly points to the 'OpenAI-Compatible Server' documentation, ensuring that the tip for forcing TransformersForCausalLM is accurate.
| You can force the use of `TransformersForCausalLM` by setting `model_impl="transformers"` for [offline-inference][offline-inference] or `--model-impl transformers` for the [serving-openai-compatible-server][openai-compatible-server]. | |
| - You can force the use of `TransformersForCausalLM` by setting `model_impl="transformers"` for [offline-inference][offline-inference] or `--model-impl transformers` for the [openai-compatible-server][openai-compatible-server]. | |
| + You can force the use of `TransformersForCausalLM` by setting `model_impl="transformers"` for [offline-inference][offline-inference] or `--model-impl transformers` for the [serving-openai-compatible-server][openai-compatible-server]. |
| - on the Hugging Face Model Hub, simply set `trust_remote_code=True` for [offline-inference][offline-inference] or `--trust-remote-code` for the [openai-compatible-server][serving-openai-compatible-server]. | ||
| - in a local directory, simply pass directory path to `model=<MODEL_DIR>` for [offline-inference][offline-inference] or `vllm serve <MODEL_DIR>` for the [openai-compatible-server][serving-openai-compatible-server]. |
There was a problem hiding this comment.
These two link updates ensure that the instructions for using models from Hugging Face Model Hub or local directories correctly reference the 'OpenAI-Compatible Server' documentation.
| - on the Hugging Face Model Hub, simply set `trust_remote_code=True` for [offline-inference][offline-inference] or `--trust-remote-code` for the [openai-compatible-server][serving-openai-compatible-server]. | |
| - in a local directory, simply pass directory path to `model=<MODEL_DIR>` for [offline-inference][offline-inference] or `vllm serve <MODEL_DIR>` for the [openai-compatible-server][serving-openai-compatible-server]. | |
| - on the Hugging Face Model Hub, simply set `trust_remote_code=True` for [offline-inference][offline-inference] or `--trust-remote-code` for the [openai-compatible-server][openai-compatible-server]. | |
| - in a local directory, simply pass directory path to `model=<MODEL_DIR>` for [offline-inference][offline-inference] or `vllm serve <MODEL_DIR>` for the [openai-compatible-server][openai-compatible-server]. | |
| + on the Hugging Face Model Hub, simply set `trust_remote_code=True` for [offline-inference][offline-inference] or `--trust-remote-code` for the [openai-compatible-server][serving-openai-compatible-server]. | |
| + in a local directory, simply pass directory path to `model=<MODEL_DIR>` for [offline-inference][offline-inference] or `vllm serve <MODEL_DIR>` for the [openai-compatible-server][serving-openai-compatible-server]. |
| @@ -1,7 +1,7 @@ | |||
| --- | |||
| title: OpenAI-Compatible Server | |||
| --- | |||
| [](){ #openai-compatible-server } | |||
| [](){ #serving-openai-compatible-server } | |||
There was a problem hiding this comment.
This is the core change that renames the anchor ID for the 'OpenAI-Compatible Server' document. All other changes in this pull request are dependent on this one. This ensures that the document can be correctly linked to using the new, more descriptive anchor.
| [](){ #serving-openai-compatible-server } | |
| [](){ #openai-compatible-server } | |
| +[](){ #serving-openai-compatible-server } |
Signed-off-by: zxw <[email protected]>
github-actions
bot
added
the
ready
Essential Elements of an Effective PR Description Checklist
supported_models.mdandexamplesfor a new model.Purpose
fix error link.
before:
iShot_2025-07-01_18.30.45.mp4
after:
iShot_2025-07-01_18.31.52.mp4
Test Plan
Test Result
(Optional) Documentation Update