[doc] Fold long code blocks to improve readability #19926
Conversation
Signed-off-by: reidliu41 <[email protected]>
|
👋 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 🚀 |
mergify
bot
added
documentation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
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 focuses on enhancing the user experience of the documentation by implementing collapsible sections for lengthy code examples, command-line outputs, and configuration snippets. This change aims to declutter the documentation pages, allowing readers to quickly grasp the main content and expand details only when needed, thereby improving overall readability and navigation.
Highlights
- Improved Documentation Readability: Long code blocks, commands, and outputs across numerous documentation files are now collapsible, making pages cleaner and easier to navigate.
- Standardized Collapsible Sections: A consistent approach using
<details>and<summary>HTML tags has been applied to various.mdfiles, allowing readers to expand content only when needed. - Enhanced User Experience: By hiding verbose content by default, the documentation becomes less overwhelming, enabling users to quickly find relevant information and delve into details as required.
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 introduces collapsible sections for long code blocks, log outputs, and commands in the documentation. The changes enhance readability and make the pages cleaner. The implementation uses <details> and <summary> tags to achieve the desired effect. The changes look good overall.
docs/ci/update_pytorch_version.md
Outdated
| @@ -91,12 +91,17 @@ source to unblock the update process. | |||
| ### FlashInfer | |||
| Here is how to build and install it from source with torch2.7.0+cu128 in vLLM [Dockerfile](https://github.com/vllm-project/vllm/blob/27bebcd89792d5c4b08af7a65095759526f2f9e1/docker/Dockerfile#L259-L271): | |||
|
|
|||
| ``` | |||
| <details> | |||
| <summary>Commands</summary> | |||
There was a problem hiding this comment.
IMO 2-3 lines isn't considered long
Signed-off-by: reidliu41 <[email protected]>
Signed-off-by: reidliu41 <[email protected]>
|
updated for removing 2 ~ 3 lines.. |
Signed-off-by: reidliu41 <[email protected]>
|
updated |
|
Can we use MkDocs collapsible blocks instead of raw html? https://squidfunk.github.io/mkdocs-material/reference/admonitions#collapsible-blocks edit: the drawback would be that all the blocks would need to be indented, which would make for a very large diff |
|
I think my main goal was to reduce the impact of long text blocks on the overall page and improve readability. |
|
I'm fine with @hmellor 's approach. We should name the admonition something like "Code" though |
Signed-off-by: reidliu41 <[email protected]>
|
updated |
github-actions
bot
added
the
ready
Signed-off-by: reidliu41 <[email protected]> Co-authored-by: reidliu41 <[email protected]> Signed-off-by: juncheoll <[email protected]>
Essential Elements of an Effective PR Description Checklist
supported_models.mdandexamplesfor a new model.Purpose
To make the page cleaner and easier to read, try to display the following content in collapsible sections:
Test Plan
Test Result
(Optional) Documentation Update