[Doc] Syntax highlight request responses as JSON instead of bash #20582
Conversation
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.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 @hmellor, 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 focuses on a minor but impactful documentation enhancement. Its purpose is to improve the presentation and readability of API response examples in the openai_compatible_server.md documentation by ensuring they are correctly syntax highlighted as JSON, rather than bash. This change directly addresses the visual accuracy and user experience of the documentation.
Highlights
- Documentation Improvement: I've updated the syntax highlighting for API response examples within the
docs/serving/openai_compatible_server.mdfile. Previously, these JSON responses were incorrectly highlighted asbash. - Enhanced Readability: By changing the code block specifier from
bashtojson, the documentation will now correctly render and highlight the JSON response bodies, significantly improving readability and clarity for users viewing the documentation in various environments (e.g., VS Code, web browsers).
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.
Code Review
This pull request updates the syntax highlighting for API responses in the documentation. By changing the markdown code block specifier from bash to json, the responses are now correctly highlighted, which improves readability. The changes are accurate and well-contained. I have no further suggestions.
…m-project#20582) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
…m-project#20582) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
…m-project#20582) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> Signed-off-by: Patrick von Platen <patrick.v.platen@gmail.com>
…m-project#20582) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
…m-project#20582) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> Signed-off-by: avigny <47987522+avigny@users.noreply.github.com>
…m-project#20582) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
…m-project#20582) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
…m-project#20582) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> Signed-off-by: Jinzhen Lin <linjinzhen@hotmail.com>
…m-project#20582) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
…m-project#20582) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Essential Elements of an Effective PR Description Checklist
supported_models.mdandexamplesfor a new model.The responses are JSON so let's label them as such (this improves the highlighing in VS Code and in the docs)
Purpose
Test Plan
Test Result
(Optional) Documentation Update