-
-
Notifications
You must be signed in to change notification settings - Fork 10.7k
[Docs] Hide the navigation and toc sidebars on home page #22749
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
Conversation
Signed-off-by: Harry Mellor <[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 🚀 |
There was a problem hiding this 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.
…t#22749) Signed-off-by: Harry Mellor <[email protected]> Signed-off-by: Diego-Castan <[email protected]>
…t#22749) Signed-off-by: Harry Mellor <[email protected]>
…t#22749) Signed-off-by: Harry Mellor <[email protected]>
…t#22749) Signed-off-by: Harry Mellor <[email protected]>
…t#22749) Signed-off-by: Harry Mellor <[email protected]> Signed-off-by: Xiao Yu <[email protected]>
…t#22749) Signed-off-by: Harry Mellor <[email protected]>
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!)