Skip to content

[Docs] Fix syntax highlighting of shell commands #19870

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

lgeiger
Copy link
Contributor

@lgeiger lgeiger commented Jun 19, 2025

This replaces console syntax highlighting with bash and only keeps console for actual terminal output.

Before:
Screenshot 2025-06-19 at 15 36 44

After:
Screenshot 2025-06-19 at 15 36 49

@lgeiger lgeiger requested a review from hmellor as a code owner June 19, 2025 14:44
Copy link

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

🚀

@mergify mergify bot added documentation Improvements or additions to documentation ci/build tpu Related to Google TPUs tool-calling labels Jun 19, 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.

Summary of Changes

Hello @lgeiger, 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 primarily focuses on enhancing the clarity and accuracy of code block syntax highlighting within the documentation. It systematically updates console language specifiers to bash for shell commands, while preserving console for actual terminal output, ensuring better rendering and readability for users. Additionally, it incorporates several minor formatting and string literal corrections found during the documentation review.

Highlights

  • Documentation Clarity: Standardized syntax highlighting for shell commands across the documentation, replacing generic console with bash where appropriate.
  • Improved Readability: Ensured that actual terminal output retains console highlighting, while interactive shell commands are clearly marked as bash for better rendering and user experience.
  • Minor Formatting Adjustments: Included several small formatting fixes, such as correcting string literals, removing trailing spaces, and adjusting table layouts in various documentation files.
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.

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

The pull request systematically updates markdown code blocks from console to bash for shell commands, improving syntax highlighting. Most changes are accurate and align with the PR's goal. A few specific blocks were identified where bash might not be the most suitable specifier (e.g., Dockerfile content, error output, JSON config). Addressing these will further enhance the documentation's clarity.

Signed-off-by: Lukas Geiger <[email protected]>
Signed-off-by: Lukas Geiger <[email protected]>
@lgeiger lgeiger requested a review from hmellor June 19, 2025 15:04
@mergify mergify bot added the performance Performance-related issues label Jun 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci/build documentation Improvements or additions to documentation performance Performance-related issues tool-calling tpu Related to Google TPUs
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

2 participants