Skip to content

Conversation

hmellor
Copy link
Member

@hmellor hmellor commented Aug 12, 2025

Since we no longer duplicate the nav on the home screen, the nav only contains a lonely link to Home.

This PR removes both sidebars from the home page to reduce the clutter and prevent users wondering where the rest of the links are on the left (they're on the top!)

@github-actions
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.

🚀

@hmellor hmellor changed the title [Docs] Hide the navigation and toc sidebars on homescreen [Docs] Hide the navigation and toc sidebars on home page Aug 12, 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.

Code Review

This pull request aims to reduce clutter on the documentation's home screen by hiding the navigation and table of contents sidebars. The change is implemented by adding YAML frontmatter to docs/README.md, which is the correct approach for the mkdocs-material theme being used. The modification is sound and achieves the stated goal without any apparent side effects. The top navigation remains available, ensuring site navigation is not hindered. I have no specific feedback as the change is correct and well-implemented.

@mergify mergify bot added the documentation Improvements or additions to documentation label Aug 12, 2025
@vllm-bot vllm-bot merged commit 45c3936 into vllm-project:main Aug 13, 2025
15 of 18 checks passed
@hmellor hmellor deleted the clean-docs-home branch August 13, 2025 06:25
diegocastanibm pushed a commit to diegocastanibm/vllm that referenced this pull request Aug 15, 2025
yiliu30 pushed a commit to yiliu30/vllm-fork that referenced this pull request Aug 19, 2025
divakar-amd pushed a commit to divakar-amd/vllm_upstream that referenced this pull request Aug 20, 2025
epwalsh pushed a commit to epwalsh/vllm that referenced this pull request Aug 28, 2025
xiao-llm pushed a commit to xiao-llm/vllm that referenced this pull request Aug 28, 2025
zhewenl pushed a commit to zhewenl/vllm that referenced this pull request Aug 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants