Skip to content

[doc] update installation compatibility doc#2868

Merged
ApostaC merged 4 commits intoLMCache:devfrom
deng451e:update_installation_compat_doc
Mar 27, 2026
Merged

[doc] update installation compatibility doc#2868
ApostaC merged 4 commits intoLMCache:devfrom
deng451e:update_installation_compat_doc

Conversation

@deng451e
Copy link
Copy Markdown
Collaborator

@deng451e deng451e commented Mar 25, 2026

What this PR does / why we need it:

Special notes for your reviewers:

If applicable:

  • this PR contains user facing changes - docs added
  • this PR contains unit tests

@deng451e
update installation compatibility doc
171e644 
Signed-off-by: deng451e <838677410@qq.com>
@gemini-code-assist
Copy link
Copy Markdown
Contributor

gemini-code-assist Bot commented Mar 25, 2026

Summary of Changes

Hello, 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 refactors and updates the installation compatibility documentation. It introduces a new CSV file to store the compatibility matrix data, separating it from the reStructuredText documentation. Additionally, it enhances the display of this matrix by adding CSS rules to enable horizontal scrolling for wide tables, ensuring a better user experience across various screen sizes.

Highlights

  • Documentation Update: The installation compatibility matrix has been updated to reflect the latest versions and compatibility status for LMCache and vLLM.
  • Improved Table Display: The compatibility matrix is now rendered with horizontal scrolling capabilities for better readability on smaller screens, preventing layout issues with wide tables.
  • Data Separation: The compatibility data has been moved from the reStructuredText file into a dedicated CSV file, improving maintainability and separation of content from presentation.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

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

gemini-code-assist[bot]
gemini-code-assist Bot reviewed Mar 25, 2026
View reviewed changes
Copy link
Copy Markdown
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

This pull request updates the documentation by externalizing the vLLM and LMCache compatibility matrix into a new CSV file (Installation_compatibility_matrix.csv) and integrating it into installation.rst. It also introduces new CSS rules in scroll.css to enable horizontal scrolling for wide tables, ensuring the compatibility matrix is displayed correctly. The review feedback points out that both the new CSS file and the new CSV file are missing a newline character at the end of the file, which is a recommended practice.

Comment thread docs/source/_static/scroll.css
Comment thread docs/source/getting_started/Installation_compatibility_matrix.csv
ApostaC
ApostaC approved these changes Mar 25, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@ApostaC ApostaC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ApostaC ApostaC enabled auto-merge (squash) March 25, 2026 23:11
KuntaiDu
KuntaiDu approved these changes Mar 25, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@KuntaiDu KuntaiDu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@deng451e deng451e added the full Run comprehensive tests on this PR label Mar 27, 2026
@ApostaC ApostaC merged commit 175cd17 into LMCache:dev Mar 27, 2026
33 checks passed
jooho-XCENA pushed a commit to xcena-dev/LMCache that referenced this pull request Apr 2, 2026
@deng451e @jooho-XCENA
[doc] update installation compatibility doc (LMCache#2868)
cbfed79 
update installation compatibility doc

Signed-off-by: deng451e <838677410@qq.com>
jooho-XCENA pushed a commit to xcena-dev/LMCache that referenced this pull request Apr 2, 2026
@deng451e @jooho-XCENA
[doc] update installation compatibility doc (LMCache#2868)
3a008b0 
update installation compatibility doc

Signed-off-by: deng451e <838677410@qq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@KuntaiDu KuntaiDu KuntaiDu approved these changes

@ApostaC ApostaC ApostaC approved these changes

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

full Run comprehensive tests on this PR

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@deng451e @KuntaiDu @ApostaC