fix: update v1 docs

[alec-flowers]

Overview:

Fixes NVBUG - https://nvbugspro.nvidia.com/bug/5382948

Summary by CodeRabbit

• Documentation
  • Updated installation instructions for vLLM to a more detailed manual process.
  • Added guidance for users of the default vLLM container to uninstall the old package before installation.
  • Improved formatting of code blocks in the documentation.

[coderabbitai]

Walkthrough

The installation instructions in the vLLM example's README were updated from a simple pip command to a step-by-step process involving cloning the repository, checking out a specific commit, and installing with custom flags. An additional note was added regarding uninstalling a previous package for certain container users.

Changes

File	Change Summary
examples/vllm_v1/README.md	Updated installation instructions to manual steps, added uninstall note, and adjusted code block formatting.

Poem

In README fields where commands once lay,
Now step-by-step guides lead the way.
Clone, checkout, install with care—
Old vLLM, please beware!
With bash and notes, instructions bloom,
Bringing clarity to every installer's room.
🐇✨

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

examples/vllm_v1/README.md (1)

52-52: Polish wording & wrap the uninstall command in a code fence

Minor readability nit:

1. Missing comma after the adverb clause.
2. The raw single quotes around the command are unnecessary; use a proper code block instead.

-If you are in the default vllm container remember to uninstall the old vllm using  'uv pip uninstall ai-dynamo-vllm'
+If you are using the default vLLM container, remember to uninstall the old package:
+
+```bash
+uv pip uninstall ai-dynamo-vllm
+```

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7bc70bc and 9f110a6.

📒 Files selected for processing (1)

• examples/vllm_v1/README.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

examples/vllm_v1/README.md

46-46: Bare URL used

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build and Test - vllm