-
-
Notifications
You must be signed in to change notification settings - Fork 10.4k
[Docs] Reduce the size of the built docs #21920
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
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 focuses on reducing the built documentation size and improving markdown consistency. The key changes include adding the mkdocs-minify-plugin
to minify assets and switching the markdown linter from pymarkdown
to markdownlint-cli
. The linter change has resulted in numerous formatting updates across the documentation, which generally improve consistency.
My review has identified a couple of high-severity issues. One is related to the new markdown linter configuration, where several important rules for link validation have been disabled globally. This could lead to broken links in the documentation. The other issue concerns some structural degradations in benchmarks/README.md
where headings have been converted to plain text.
Overall, the PR is a good step towards better documentation infrastructure. Addressing the mentioned points will further improve the quality and maintainability of the docs.
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 🚀 |
Signed-off-by: Harry Mellor <[email protected]>
Signed-off-by: Harry Mellor <[email protected]>
Signed-off-by: Harry Mellor <[email protected]> Signed-off-by: x22x22 <[email protected]>
Signed-off-by: Harry Mellor <[email protected]>
Signed-off-by: Harry Mellor <[email protected]> Signed-off-by: Jinzhen Lin <[email protected]>
Signed-off-by: Harry Mellor <[email protected]> Signed-off-by: Noam Gat <[email protected]>
Signed-off-by: Harry Mellor <[email protected]> Signed-off-by: Paul Pak <[email protected]>
Signed-off-by: Harry Mellor <[email protected]> Signed-off-by: Diego-Castan <[email protected]>
Signed-off-by: Harry Mellor <[email protected]>
Signed-off-by: Harry Mellor <[email protected]>
Reduces the total size of the built docs from ~350MB to ~310MB which is a ~11% reduction