fix: typo in .devcontainer/README.md from "./container/build.sh --tar…

[lynnmatrix]

Overview:

This pull request fixes a typo in the .devcontainer/README.md file. It corrects the Docker build target from ./container/build.sh --target dev to ./container/build.sh --target local-dev.

Details:

• Correction: The Docker build target has been changed to local-dev, which is the correct target for the development container image.
• Reasoning: The local-dev image uses the current user and group IDs from the host system as USER_UID and USER_GID.

Where should the reviewer start?

single file changed: .devcontainer/README.md

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

Relates to PR #2892

Summary by CodeRabbit

• Documentation
  • Updated the development container setup guide to reflect the latest build command, targeting local development while maintaining compatibility with the VLLM framework.
  • Clarified step-by-step instructions to improve accuracy and reduce potential setup issues during environment preparation.
  • Enhances readability and consistency of setup guidance without affecting application behavior or user-facing features.

[copy-pr-bot]

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

[github-actions]

👋 Hi lynnmatrix! Thank you for contributing to ai-dynamo/dynamo.

Just a reminder: The NVIDIA Test Github Validation CI runs an essential subset of the testing framework to quickly catch errors.Your PR reviewers may elect to test the changes comprehensively before approving your changes.

🚀

[coderabbitai]

Walkthrough

Updates .devcontainer/README.md to change the Step 1 container build command’s target from dev to local-dev while retaining --framework VLLM and leaving other text unchanged.

Changes

Cohort / File(s)	Summary
Devcontainer docs .devcontainer/README.md	Switches build target in Step 1 from dev to local-dev; preserves --framework VLLM and other content.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• build: default to using dev instead of local-dev for vllm build #2834 — Also changes the VLLM build command target in .devcontainer/README.md, making it directly related to this adjustment.

Poem

A hop, a flip, a tiny rev,
From dev to local-dev I’ve leapt, so deft.
VLLM stays—no lines to shave—
Just nudged the dial, a subtle wave.
Carrots compiled, README prepped. 🥕✨

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title clearly identifies the change as a fix to a typo in .devcontainer/README.md and references the build command that was corrected, so it is directly related to the single-file change in the PR; it is concise and specific enough for a reviewer scanning history to understand the primary change. Therefore it meets the repository's title criteria.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.
Description Check	✅ Passed	The pull request description follows the repository template and includes the required sections (Overview, Details, Where should the reviewer start, and Related Issues); it clearly states the single-file change (fixing the Docker build target) and the rationale (local-dev uses host USER_UID/USER_GID), giving reviewers sufficient context.

---

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

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

.devcontainer/README.md (1)

94-101: Align image name in text with the updated target.

The Step 1 sentence says “Build dynamo:latest-vllm…”, but the diagram and command produce dynamo:latest-vllm-local-dev. Recommend updating the text for consistency.

- Build `dynamo:latest-vllm` from scratch from the source:
+ Build `dynamo:latest-vllm-local-dev` from scratch from the source:

Also applies to: 44-46

📜 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 1b2826a and 08e8b30.

📒 Files selected for processing (1)

• .devcontainer/README.md (1 hunks)

🧰 Additional context used

🧠 Learnings (4)

📓 Common learnings

Learnt from: keivenchang
PR: ai-dynamo/dynamo#2797
File: container/Dockerfile:437-449
Timestamp: 2025-08-30T20:43:49.632Z
Learning: In the dynamo project's devcontainer setup, the team prioritizes consistency across framework-specific Dockerfiles (like container/Dockerfile, container/Dockerfile.vllm, etc.) by mirroring their structure, even when individual optimizations might be possible, to maintain uniformity in the development environment setup.

Learnt from: keivenchang
PR: ai-dynamo/dynamo#2797
File: .devcontainer/devcontainer.json:12-12
Timestamp: 2025-08-30T20:43:10.091Z
Learning: In the dynamo project, devcontainer.json files use templated container names (like "dynamo-vllm-devcontainer") that are automatically processed by the copy_devcontainer.sh script to generate framework-specific configurations with unique names, preventing container name collisions.

📚 Learning: 2025-08-30T20:43:49.632Z

Learnt from: keivenchang
PR: ai-dynamo/dynamo#2797
File: container/Dockerfile:437-449
Timestamp: 2025-08-30T20:43:49.632Z
Learning: In the dynamo project's devcontainer setup, the team prioritizes consistency across framework-specific Dockerfiles (like container/Dockerfile, container/Dockerfile.vllm, etc.) by mirroring their structure, even when individual optimizations might be possible, to maintain uniformity in the development environment setup.

Applied to files:

• .devcontainer/README.md

📚 Learning: 2025-09-03T01:10:12.599Z

Learnt from: keivenchang
PR: ai-dynamo/dynamo#2822
File: container/Dockerfile.vllm:343-352
Timestamp: 2025-09-03T01:10:12.599Z
Learning: In the dynamo project's local-dev Docker targets, USER_UID and USER_GID build args are intentionally left without default values to force explicit UID/GID mapping during build time, preventing file permission issues in local development environments where container users need to match host user permissions for mounted volumes.

Applied to files:

• .devcontainer/README.md

📚 Learning: 2025-08-30T20:43:10.091Z

Learnt from: keivenchang
PR: ai-dynamo/dynamo#2797
File: .devcontainer/devcontainer.json:12-12
Timestamp: 2025-08-30T20:43:10.091Z
Learning: In the dynamo project, devcontainer.json files use templated container names (like "dynamo-vllm-devcontainer") that are automatically processed by the copy_devcontainer.sh script to generate framework-specific configurations with unique names, preventing container name collisions.

Applied to files:

• .devcontainer/README.md

⏰ 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

🔇 Additional comments (2)

.devcontainer/README.md (2)

97-98: Change to local-dev target looks correct.

Using --target local-dev aligns with the intended dev image and UID/GID mapping behavior noted elsewhere in this doc.

---

96-101: Resolved — build.sh already injects USER_UID/USER_GID for local-dev

container/build.sh adds "--build-arg USER_UID=$(id -u) --build-arg USER_GID=$(id -g)" when TARGET == "local-dev" (container/build.sh lines 471–473). No README change required.

[github-actions]

This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.

[github-actions]

This PR has been closed due to inactivity. If you believe this PR is still relevant, please feel free to reopen it with additional context or information.