[doc] Add Slack and Forum to the top navigation #20208

reidliu41 · 2025-06-28T10:53:42Z

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.

Purpose

This makes it easy for users to quickly access and join the Slack workspace.

Test Plan

Test Result

(Optional) Documentation Update

github-actions · 2025-06-28T10:53:49Z

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

🚀

gemini-code-assist

Summary of Changes

Hello @reidliu41, I'm Gemini Code Assist¹! 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 introduces a user experience improvement to the documentation website by integrating a prominent Slack button into the top navigation. The primary goal is to facilitate easier access for users to join the project's Slack community, thereby enhancing engagement and support channels.

Highlights

Documentation Enhancement: A new Slack button has been added to the top navigation bar of the documentation website, providing users with a direct link to join the project's Slack workspace.
Frontend Implementation: The Slack button is implemented using a new JavaScript file (slack.js) that dynamically creates and inserts the button into the header, and new CSS rules (extra.css) to style its appearance and hover effects.
Build Configuration Update: The mkdocs.yaml configuration file has been updated to include the new slack.js JavaScript file, ensuring it is loaded and executed as part of the documentation site.

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.

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

gemini-code-assist

Code Review

This PR adds a Slack button to the header. The review suggests using a semantically correct HTML element (<a> instead of <button>) and centralizing all styling in the CSS file. These changes will improve maintainability and accessibility.

gemini-code-assist · 2025-06-28T10:56:40Z

docs/mkdocs/javascript/slack.js

+    const slackButton = document.createElement('button');
+    slackButton.className = 'slack-button';
+    slackButton.title = 'Join us on Slack';
+    slackButton.style.border = 'none';
+    slackButton.style.background = 'transparent';
+    slackButton.style.cursor = 'pointer';
+
+    slackButton.innerHTML = `
+      <img src="https://a.slack-edge.com/80588/marketing/img/icons/icon_slack_hash_colored.png" 
+           style="height: 1.4rem;" 
+           alt="Slack">
+    `;
+
+    slackButton.addEventListener('click', () => {
+      window.open('https://slack.vllm.ai', '_blank', 'noopener');
+    });


Consider using an anchor (<a>) tag instead of a <button> element for navigation. This is more semantically correct and improves accessibility. Also, it's better to avoid inline styles and move them to the CSS file for better maintainability.

Suggested change

const slackButton = document.createElement('button');

slackButton.className = 'slack-button';

slackButton.title = 'Join us on Slack';

slackButton.style.border = 'none';

slackButton.style.background = 'transparent';

slackButton.style.cursor = 'pointer';

slackButton.innerHTML = `

<img src="https://a.slack-edge.com/80588/marketing/img/icons/icon_slack_hash_colored.png"

style="height: 1.4rem;"

alt="Slack">

`;

slackButton.addEventListener('click', () => {

window.open('https://slack.vllm.ai', '_blank', 'noopener');

});

const slackLink = document.createElement('a');

slackLink.className = 'slack-button';

slackLink.title = 'Join us on Slack';

slackLink.href = 'https://slack.vllm.ai';

slackLink.target = '_blank';

slackLink.rel = 'noopener noreferrer';

slackLink.innerHTML = `

<img src="https://a.slack-edge.com/80588/marketing/img/icons/icon_slack_hash_colored.png"

alt="Slack">

`;

reidliu41 · 2025-06-28T11:22:13Z

cc @DarkLight1337

DarkLight1337 · 2025-06-28T12:03:48Z

cc @simon-mo are you ok with this?

DarkLight1337 · 2025-06-28T12:05:34Z

Personally I think the icon is a bit too big, it should have a similar size as the Git icon.

simon-mo · 2025-06-28T12:46:46Z

Forum might be better for top level. Potentially both.

Signed-off-by: reidliu41 <[email protected]>

reidliu41 · 2025-06-28T15:58:50Z

…vigation

reidliu41 · 2025-06-30T01:17:30Z

@DarkLight1337 updated, could you please take a look if you have time? thanks

DarkLight1337 · 2025-06-30T02:36:08Z

The Forum button looks a bit offset

Signed-off-by: reidliu41 <[email protected]>

reidliu41 · 2025-06-30T03:52:00Z

reidliu41 · 2025-06-30T03:58:51Z

updated

DarkLight1337 · 2025-06-30T04:08:41Z

Can you move the icon downwards a bit? It doesn't look centered

Signed-off-by: reidliu41 <[email protected]>

reidliu41 · 2025-06-30T04:32:17Z

reidliu41 · 2025-06-30T06:12:31Z

Moved it

DarkLight1337

LGTM now, thanks for adjusting the style!

Signed-off-by: reidliu41 <[email protected]>

Signed-off-by: reidliu41 <[email protected]> Signed-off-by: avigny <[email protected]>

Signed-off-by: reidliu41 <[email protected]>

reidliu41 requested a review from hmellor as a code owner June 28, 2025 10:53

gemini-code-assist bot reviewed Jun 28, 2025

View reviewed changes

mergify bot added the documentation Improvements or additions to documentation label Jun 28, 2025

gemini-code-assist bot reviewed Jun 28, 2025

View reviewed changes

[doc] Add Slack and Forum to the top navigation

926af7f

Signed-off-by: reidliu41 <[email protected]>

reidliu41 force-pushed the add-slack-on-top-navigation branch from c5caf00 to 926af7f Compare June 28, 2025 15:57

reidliu41 changed the title ~~[doc] Add Slack to the top navigation~~ [doc] Add Slack and Forum to the top navigation Jun 28, 2025

Merge remote-tracking branch 'upstream/main' into add-slack-on-top-na…

0c9d689

…vigation

update css

db4b919

Signed-off-by: reidliu41 <[email protected]>

downward 2px

d8566f3

Signed-off-by: reidliu41 <[email protected]>

DarkLight1337 approved these changes Jun 30, 2025

View reviewed changes

DarkLight1337 enabled auto-merge (squash) June 30, 2025 06:13

github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Jun 30, 2025

DarkLight1337 merged commit 022c58b into vllm-project:main Jun 30, 2025
56 of 58 checks passed

CSWYF3634076 pushed a commit to CSWYF3634076/vllm that referenced this pull request Jul 2, 2025

[doc] Add Slack and Forum to the top navigation (vllm-project#20208)

83e3381

Signed-off-by: reidliu41 <[email protected]>

avigny pushed a commit to avigny/vllm that referenced this pull request Jul 31, 2025

[doc] Add Slack and Forum to the top navigation (vllm-project#20208)

3764f67

Signed-off-by: reidliu41 <[email protected]> Signed-off-by: avigny <[email protected]>

googlercolin pushed a commit to googlercolin/vllm that referenced this pull request Aug 29, 2025

[doc] Add Slack and Forum to the top navigation (vllm-project#20208)

7991de3

Signed-off-by: reidliu41 <[email protected]>

Uh oh!

[doc] Add Slack and Forum to the top navigation #20208

[doc] Add Slack and Forum to the top navigation #20208

Uh oh!

Conversation

reidliu41 commented Jun 28, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Essential Elements of an Effective PR Description Checklist

Purpose

Test Plan

Test Result

(Optional) Documentation Update

Uh oh!

github-actions bot commented Jun 28, 2025

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Jun 28, 2025

Choose a reason for hiding this comment

Uh oh!

reidliu41 commented Jun 28, 2025

Uh oh!

DarkLight1337 commented Jun 28, 2025

Uh oh!

DarkLight1337 commented Jun 28, 2025

Uh oh!

simon-mo commented Jun 28, 2025

Uh oh!

reidliu41 commented Jun 28, 2025

Uh oh!

reidliu41 commented Jun 30, 2025

Uh oh!

DarkLight1337 commented Jun 30, 2025

Uh oh!

reidliu41 commented Jun 30, 2025

Uh oh!

reidliu41 commented Jun 30, 2025

Uh oh!

DarkLight1337 commented Jun 30, 2025

Uh oh!

reidliu41 commented Jun 30, 2025

Uh oh!

reidliu41 commented Jun 30, 2025

Uh oh!

DarkLight1337 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

reidliu41 commented Jun 28, 2025 •

edited by github-actions bot

Loading