Skip to content

docs: remove hardcoded version in quick start#3290

Merged
nv-anants merged 2 commits into
mainfrom
anants/remove-qs-version
Sep 29, 2025
Merged

docs: remove hardcoded version in quick start#3290
nv-anants merged 2 commits into
mainfrom
anants/remove-qs-version

Conversation

@nv-anants

@nv-anants nv-anants commented Sep 29, 2025

Copy link
Copy Markdown
Member

Overview:

Remove hardcoded version in quick start

closes: OPS-1279

Summary by CodeRabbit

  • Documentation
    • Updated Quick Start to support installing prerelease versions via uv pip with --prerelease=allow.
    • Instructions now fetch the docker-compose file matching the installed package version dynamically.
    • All other setup steps remain unchanged.

@github-actions github-actions Bot added the docs label Sep 29, 2025
@nv-anants nv-anants marked this pull request as ready for review September 29, 2025 19:01
@coderabbitai

coderabbitai Bot commented Sep 29, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

Updates quick start docs to install ai-dynamo[sglang] via uv with prereleases allowed and to download docker-compose.yml dynamically based on the installed package’s version obtained from uv pip show, replacing previously pinned version references.

Changes

Cohort / File(s) Summary of Changes
Docs: Quick Start local setup
docs/_includes/quick_start_local.rst
Switches install command to uv pip install --prerelease=allow "ai-dynamo[sglang]". Replaces hardcoded docker-compose URL (release/0.4.1) with dynamic versioned URL using `VERSION=$(uv pip show ai-dynamo

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

Thump-thump go my paws in docs delight,
Versions now dance to the install’s light;
UV whispers, “fetch what’s right,” I nod—
Compose follows version, neat and mod.
Carrot-shaped URLs, crisp and clear—
Hop, ship, run—latest lands right here! 🥕✨

Pre-merge checks

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The pull request description provides an Overview section that briefly explains the purpose (removing hardcoded version in quick start) and includes a reference to the related issue (OPS-1279). However, the description is missing two required sections from the template: the "Details" section that should describe the specific changes made in the PR, and the "Where should the reviewer start?" section that should call out specific files for close review. While the Overview and Related Issues sections are present, the absence of the Details section means reviewers lack information about the specific technical changes (replacing pinned version with prerelease-enabled install, dynamic docker-compose URL, etc.). To pass this check, the author should add a "Details" section explaining the technical changes (e.g., replacing the pinned ai-dynamo[sglang]==0.4.1 installation with a dynamic version approach using --prerelease=allow, and updating the docker-compose URL to use the installed package version). Additionally, a "Where should the reviewer start?" section should be added to indicate that docs/_includes/quick_start_local.rst is the primary file to review. The Related Issues section should also use one of the action keywords (Closes/Fixes/Resolves) instead of just "closes:" as shown in the template.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The pull request title "docs: remove hardcoded version in quick start" accurately and clearly describes the main change in the changeset. The changes replace hardcoded version references (specifically 0.4.1) with dynamic version-based references in the quick start documentation file, making the documentation more maintainable. The title is concise, specific, and directly related to the primary objective of the pull request, allowing teammates to understand what was changed at a glance.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

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
🧪 Early access (Sonnet 4.5): enabled

We are currently testing the Sonnet 4.5 model, which is expected to improve code review quality. However, this model may lead to increased noise levels in the review comments. Please disable the early access features if the noise level causes any inconvenience.

Note:

  • Public repositories are always opted into early access features.
  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 2

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 65071f2 and 9e1aaf3.

📒 Files selected for processing (1)
  • docs/_includes/quick_start_local.rst (1 hunks)
⏰ 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 - dynamo

Comment thread docs/_includes/quick_start_local.rst
Comment thread docs/_includes/quick_start_local.rst Outdated
Comment thread docs/_includes/quick_start_local.rst Outdated
Signed-off-by: Anant Sharma <anants@nvidia.com>
@nv-anants nv-anants enabled auto-merge (squash) September 29, 2025 20:32
@nv-anants nv-anants merged commit e3df305 into main Sep 29, 2025
18 checks passed
@nv-anants nv-anants deleted the anants/remove-qs-version branch September 29, 2025 20:50
yao531441 pushed a commit to yao531441/dynamo that referenced this pull request May 13, 2026
Signed-off-by: Anant Sharma <anants@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants