Skip to content

Conversation

hmellor
Copy link
Member

@hmellor hmellor commented Jul 30, 2025

Reduces the total size of the built docs from ~350MB to ~310MB which is a ~11% reduction

@mergify mergify bot added documentation Improvements or additions to documentation ci/build performance Performance-related issues labels Jul 30, 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 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.

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.

🚀

@vllm-bot vllm-bot merged commit 88edf59 into vllm-project:main Jul 30, 2025
12 of 14 checks passed
@hmellor hmellor deleted the minify-docs branch July 30, 2025 14:35
liuyumoye pushed a commit to liuyumoye/vllm that referenced this pull request Jul 31, 2025
vadiklyutiy pushed a commit to CentML/vllm that referenced this pull request Aug 5, 2025
x22x22 pushed a commit to x22x22/vllm that referenced this pull request Aug 5, 2025
npanpaliya pushed a commit to odh-on-pz/vllm-upstream that referenced this pull request Aug 6, 2025
jinzhen-lin pushed a commit to jinzhen-lin/vllm that referenced this pull request Aug 9, 2025
noamgat pushed a commit to noamgat/vllm that referenced this pull request Aug 9, 2025
paulpak58 pushed a commit to paulpak58/vllm that referenced this pull request Aug 13, 2025
diegocastanibm pushed a commit to diegocastanibm/vllm that referenced this pull request Aug 15, 2025
epwalsh pushed a commit to epwalsh/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
ci/build documentation Improvements or additions to documentation performance Performance-related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants