-
-
Notifications
You must be signed in to change notification settings - Fork 8.6k
[doc] use snippets for contact us #19944
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.
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
Conversation
Signed-off-by: reidliu41 <reid201711@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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @reidliu41, 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 streamlines the management of the "Contact Us" information across the project's documentation. By implementing a snippet-based approach, it centralizes the source of truth for contact details in the README.md
, ensuring consistency and simplifying future updates for all related documentation pages.
Highlights
- Documentation Snippet Implementation: The 'Contact Us' section in
README.md
is now marked with<!-- --8<-- [start:contact-us] -->
and<!-- --8<-- [end:contact-us] -->
comments, defining it as a reusable content snippet. - Centralized Content Source: The
docs/community/contact_us.md
file has been updated to dynamically include the 'Contact Us' snippet fromREADME.md
using the--8<-- "README.md:contact-us"
directive, eliminating content duplication. - Improved Documentation Maintainability: Obsolete comments that previously instructed manual synchronization between
README.md
anddocs/community/contact_us.md
have been removed, as the new snippet mechanism automates this process.
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. ↩
There was a problem hiding this 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 refactors the 'Contact Us' section to use markdown snippets, which is a great way to reduce duplication and ensure consistency between the main README.md
and the documentation site.
I have two suggestions:
- A stylistic improvement in
README.md
to make the snippet definition more compact. - A more critical fix in
docs/community/contact_us.md
regarding the file path for the snippet, which is likely incorrect and could break the documentation build.
Please make sure to test the documentation build locally to confirm the changes work as expected. Overall, a good improvement for documentation maintainability.
- For security disclosures, please use GitHub's [Security Advisories](https://github.com/vllm-project/vllm/security/advisories) feature | ||
- For collaborations and partnerships, please contact us at [vllm-questions@lists.berkeley.edu](mailto:vllm-questions@lists.berkeley.edu) | ||
<!-- Please keep this file up to date with the "Contact Us" section in vllm/README.md. --> | ||
--8<-- "README.md:contact-us" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The path to README.md
seems to be incorrect. According to the mkdocs-material
snippets documentation, paths for snippets are relative to the docs
directory. Since README.md
is in the project root (one level above docs
), the path should likely be ../README.md
.
Without this change, the documentation build might fail or the content will not be rendered correctly. Could you please verify the path and test the documentation build locally?
--8<-- "README.md:contact-us" | |
--8<-- "../README.md:contact-us" |
README.md
Outdated
<!-- --8<-- [start:contact-us] --> | ||
|
||
- For technical questions and feature requests, please use GitHub [Issues](https://github.com/vllm-project/vllm/issues) or [Discussions](https://github.com/vllm-project/vllm/discussions) | ||
- For discussing with fellow users, please use the [vLLM Forum](https://discuss.vllm.ai) | ||
- For coordinating contributions and development, please use [Slack](https://slack.vllm.ai) | ||
- For security disclosures, please use GitHub's [Security Advisories](https://github.com/vllm-project/vllm/security/advisories) feature | ||
- For collaborations and partnerships, please contact us at [vllm-questions@lists.berkeley.edu](mailto:vllm-questions@lists.berkeley.edu) | ||
<!-- Please keep this section up to date with vllm/docs/community/contact_us.md. --> | ||
|
||
<!-- --8<-- [end:contact-us] --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For better readability and to keep the snippet definition concise, you can remove the blank lines within the start:contact-us
and end:contact-us
markers. The surrounding blank lines are sufficient to ensure correct Markdown rendering.
<!-- --8<-- [start:contact-us] --> | |
- For technical questions and feature requests, please use GitHub [Issues](https://github.com/vllm-project/vllm/issues) or [Discussions](https://github.com/vllm-project/vllm/discussions) | |
- For discussing with fellow users, please use the [vLLM Forum](https://discuss.vllm.ai) | |
- For coordinating contributions and development, please use [Slack](https://slack.vllm.ai) | |
- For security disclosures, please use GitHub's [Security Advisories](https://github.com/vllm-project/vllm/security/advisories) feature | |
- For collaborations and partnerships, please contact us at [vllm-questions@lists.berkeley.edu](mailto:vllm-questions@lists.berkeley.edu) | |
<!-- Please keep this section up to date with vllm/docs/community/contact_us.md. --> | |
<!-- --8<-- [end:contact-us] --> | |
<!-- --8<-- [start:contact-us] --> | |
- For technical questions and feature requests, please use GitHub [Issues](https://github.com/vllm-project/vllm/issues) or [Discussions](https://github.com/vllm-project/vllm/discussions) | |
- For discussing with fellow users, please use the [vLLM Forum](https://discuss.vllm.ai) | |
- For coordinating contributions and development, please use [Slack](https://slack.vllm.ai) | |
- For security disclosures, please use GitHub's [Security Advisories](https://github.com/vllm-project/vllm/security/advisories) feature | |
- For collaborations and partnerships, please contact us at [vllm-questions@lists.berkeley.edu](mailto:vllm-questions@lists.berkeley.edu) | |
<!-- --8<-- [end:contact-us] --> |
Signed-off-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com> Signed-off-by: juncheoll <th6re8e@naver.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com> Signed-off-by: fhl <2410591650@qq.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com> Signed-off-by: Will Eaton <weaton@redhat.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com>
Essential Elements of an Effective PR Description Checklist
supported_models.md
andexamples
for a new model.Purpose
For #19922 (comment)
Test Plan
Test Result
(Optional) Documentation Update