-
-
Notifications
You must be signed in to change notification settings - Fork 10.4k
[Docs] Improve API docs (+small tweaks) #22459
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]>
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 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.
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.
The docs LGTM, thanks!
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]>
Signed-off-by: Harry Mellor <[email protected]> Signed-off-by: Xiao Yu <[email protected]>
Signed-off-by: Harry Mellor <[email protected]>
Merge after tlambert03/mkdocs-api-autonav#23 and
mkdocs-api-autonav
release.mkdocs.yaml
and re-enablenavigation.indexes
to improve the UX of the API docs