Skip to content

Conversation

hmellor
Copy link
Member

@hmellor hmellor commented Aug 7, 2025

Merge after tlambert03/mkdocs-api-autonav#23 and mkdocs-api-autonav release.

  • Removes yaml frontmatter and unused explicit anchor from intel doc
  • Removes workaround from mkdocs.yaml and re-enable navigation.indexes to improve the UX of the API docs
Before After
image image

Copy link

github-actions bot commented Aug 7, 2025

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

🚀

@mergify mergify bot added the documentation Improvements or additions to documentation label Aug 7, 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 improve the documentation by tweaking the mkdocs configuration. The changes include standardizing page titles to use Markdown headers and removing an obsolete configuration. However, one of the changes in docs/.nav.yml might have an unintended side effect on the API reference navigation. I've added a comment with a suggestion to address this potential issue.

@hmellor hmellor changed the title Docs-tweaks [Docs] Improve API docs (+small tweaks) Aug 7, 2025
@hmellor hmellor marked this pull request as ready for review August 8, 2025 09:48
Copy link
Member

@DarkLight1337 DarkLight1337 left a comment

Choose a reason for hiding this comment

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

The docs LGTM, thanks!

@vllm-bot vllm-bot merged commit 7be7f38 into vllm-project:main Aug 8, 2025
13 of 15 checks passed
@hmellor hmellor deleted the docs-tweaks branch August 8, 2025 11:24
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
yiliu30 pushed a commit to yiliu30/vllm-fork that referenced this pull request Aug 19, 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