[Misc] Correct broken docs link #19553
Conversation
Signed-off-by: Zerohertz <ohg3417@gmail.com>
|
👋 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 🚀 |
There was a problem hiding this comment.
Summary of Changes
Hello @Zerohertz, 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 a minor but important documentation issue by updating an incorrect link within the command-line interface help text for the vllm serve command's --config argument. This change improves the usability of the CLI by providing users with the correct resource for understanding configuration options.
Highlights
- Documentation Fix: Corrected a broken documentation link found in the help text for the
--configcommand-line option. - CLI Usability: Ensured the
vllm serve --helpoutput directs users to the correct documentation page for configuration options.
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 configureGemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request effectively addresses an incorrect documentation link within the --config option's help text. The change also improves the formatting of the help message by ensuring proper spacing between sentences and before the URL. The provided test plan and results clearly demonstrate the correction. The code modification is straightforward and looks good.
|
Additionally, in the above command, the default value is |
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
Signed-off-by: Zerohertz <ohg3417@gmail.com> Signed-off-by: minpeter <kali2005611@gmail.com>
Signed-off-by: Zerohertz <ohg3417@gmail.com>
Signed-off-by: Zerohertz <ohg3417@gmail.com>
Signed-off-by: Zerohertz <ohg3417@gmail.com> Signed-off-by: avigny <47987522+avigny@users.noreply.github.com>
Signed-off-by: Zerohertz <ohg3417@gmail.com>
Essential Elements of an Effective PR Description Checklist
supported_models.mdandexamplesfor a new model.Purpose
This PR fixes an incorrect documentation link in the help text for the
--configoption when usingvllm serve.Test Plan
Test Result
--config CONFIG Read CLI options from a config file.Must be a YAML with the following options:https://docs.vllm.ai/en/lat est/serving/openai_compatible_server.html#cli- reference (default: )--config CONFIG Read CLI options from a config file. Must be a YAML with the following options: https://docs.vllm.ai/en/la test/configuration/serve_args.html (default: )(Optional) Documentation Update