docs: Adjust the path to examples

[atchernych]

Overview:

Overall plan https://linear.app/nvidia-dynamo/issue/DYN-591/dynamo-user-experience-and-documentation-improvements

Details:

Linear Issue https://linear.app/nvidia-dynamo/issue/DYN-740/adjust-the-path-to-examples-after-they-were-moved-to-componentsbackend

Where should the reviewer start?

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

• closes GitHub issue: #xxx

Summary by CodeRabbit

• Documentation
  • Updated README instructions for building and using the Dynamo base image.
  • Clarified availability of prebuilt images on nvcr.io.
  • Moved custom build instructions to an alternative option.
  • Replaced explicit local testing commands with a reference to a Quickstart Guide for deployment instructions.

[coderabbitai]

Walkthrough

The README.md file was updated to clarify the instructions for building and using the Dynamo base image. References to building and pushing images were revised, a note about prebuilt images on nvcr.io was added, and example commands for local testing were replaced with a reference to a Quickstart Guide.

Changes

File(s)	Change Summary
README.md	Clarified instructions for base image usage, added note on prebuilt images, updated deployment guidance, and replaced example commands with a Quickstart Guide reference.

Estimated code review effort

1 (~2 minutes)

Possibly related PRs

• docs: Add docs.nvidia.com userguides link #1378: Updates README.md to improve documentation by clarifying references to user guides and deployment instructions, similar to the changes in this PR.

Poem

🐇
In README fields where guidance grows,
Clearer paths the rabbit shows.
Prebuilt images, quick to find,
And Quickstart Guides for peace of mind.
With every hop, instructions gleam—
Deploying Dynamo’s now a dream!

---

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: 0

🧹 Nitpick comments (2)

README.md (2)

71-77: Grammar & wording – “use … to your registry” is awkward

The new sentence still reads as if a push is required (“use … to your container registry”).
Consider reverting to “push” or dropping “to your container registry” for clarity.

-... will require you to use a Dynamo base image to your container registry.
+... will require you to push a Dynamo base image to your container registry.

---

187-202: Quick-start link is inside a bash fence & will render as code

Because the ```bash block opened at 187 isn’t closed before the “Follow the Quickstart Guide …” line, the link appears as literal text and is not clickable.
Close the fence first, then place the link outside.

- pip install ".[all]"
-
- Follow the [Quickstart Guide](docs/guides/dynamo_deploy/quickstart.md)
+pip install ".[all]"
+```
+
+Follow the [Quickstart Guide](docs/guides/dynamo_deploy/quickstart.md)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9cfaa7b and 8dd3e26.

📒 Files selected for processing (1)

• README.md (2 hunks)