Skip to content

Improve examples rendering in docs and GitHub #18203

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
May 15, 2025
Merged

Improve examples rendering in docs and GitHub #18203

merged 5 commits into from
May 15, 2025

Conversation

hmellor
Copy link
Member

@hmellor hmellor commented May 15, 2025

  • Renames the md files to README.md so that they are rendered when browsing GitHub
  • Adds some README.md files to multi-file examples which had no md, and therefore were missing from the docs

hmellor added 4 commits May 15, 2025 13:47
@hmellor
Rename Otel.md -> README.md
8543f1e 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@hmellor
Make disagg example visible (and move kv_events into it)
587b6ac 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@hmellor
Rename openai_batch.md -> README.md
1c7f2b1 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@hmellor
Make the offline disagg prefill example visible in docs
fee0e23 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@github-actions GitHub Actions
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.

🚀

@mergify mergify bot added the documentation Improvements or additions to documentation label May 15, 2025
DarkLight1337
DarkLight1337 approved these changes May 15, 2025
View reviewed changes
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.

Thanks for fixing!

@DarkLight1337 DarkLight1337 enabled auto-merge (squash) May 15, 2025 13:22
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label May 15, 2025
@DarkLight1337
Copy link
Member

Hmm the build is failing

@hmellor
Remove links that MyST doesn't understand
9a86b5c 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@DarkLight1337 DarkLight1337 merged commit 51ff154 into vllm-project:main May 15, 2025
40 checks passed
@hmellor hmellor deleted the fix-examples branch May 15, 2025 16:05
gshtras pushed a commit to ROCm/vllm that referenced this pull request May 15, 2025
@hmellor @gshtras
Improve examples rendering in docs and GitHub (vllm-project#18203)
18e107a 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Gregory Shtrasberg <Gregory.Shtrasberg@amd.com>
ChenheliHua pushed a commit to ChenheliHua/vllm that referenced this pull request May 22, 2025
@hmellor @ChenheliHua
Improve examples rendering in docs and GitHub (vllm-project#18203)
90aafd6 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Chenheli Hua <huachenheli@outlook.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DarkLight1337 DarkLight1337 DarkLight1337 approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation ready ONLY add when PR is ready to merge/full CI is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@hmellor @DarkLight1337