Skip to content

Conversation

@nv-nmailhot
Copy link
Contributor

@nv-nmailhot nv-nmailhot commented Sep 9, 2025

Overview:

Fixing this now broken link since the file name got changed in this commit: ad4821c#diff-aa9b4ce42905c33f44eec9ee1cbbc1b9d1bcc9295816b08a91515f60f74a9417

Details:

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 outdated “Dynamo Cloud” links to the current Installation Guide across deployment documentation for multiple backends (e.g., sglang, TensorRT-LLM, vLLM) and the AKS deployment example.
    • Corrected references in Prerequisites, Platform Setup, Further Reading, and task steps to ensure users reach the latest installation instructions.
    • Improves navigation and reduces confusion; no functional or behavioral changes to the product.

@rmccorm4 rmccorm4 changed the title change broken link docs: fix broken links Sep 9, 2025
@github-actions github-actions bot added the docs label Sep 9, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 9, 2025

Walkthrough

Updated documentation links in four README/guide files to point from dynamo_cloud.md to installation_guide.md. No code or behavior changes.

Changes

Cohort / File(s) Summary of Changes
Backend deploy READMEs
components/backends/*/deploy/README.md (sglang, trtllm, vllm)
Repointed “Dynamo Cloud Installation” links from dynamo_cloud.md to installation_guide.md (single occurrence in trtllm; two occurrences in sglang and vllm).
AKS deployment docs
examples/deployments/AKS/AKS-deployment.md
Updated two references from dynamo_cloud.md to installation_guide.md (step 2 in Task 3 and a general “other ways to install” sentence).

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

A hop and a link, I tidy the trail,
From cloud to install, I fine-tune the tale.
Little paws fixing paths, light as a breeze,
Docs now align with elegant ease.
Thump-thump—merged! 🥕✨

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.

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 (2 passed, 1 warning)

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The pull request description uses the required template headings but contains only placeholder text and does not provide an overview of the link updates, details of the specific changes made, file locations for review, or a valid related issue reference, leaving all substantive sections empty. Populate each section of the template with actual content: summarize the link updates under Overview, list the specific files and link replacements under Details, indicate the key files for reviewers under Where should the reviewer start?, and replace “#xxx” with the correct issue number or remove if not applicable.
✅ Passed checks (2 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Title Check ✅ Passed The title “docs: fix broken links” succinctly describes the core change—updating and repairing documentation link targets—without extraneous detail, accurately reflecting the main modifications across multiple README files. It is concise, focused on the primary update, and conveys the intent clearly for anyone scanning the history.

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

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
components/backends/sglang/deploy/README.md (1)

77-77: Documentation links validated
Verified that docs/guides/dynamo_deploy/installation_guide.md exists, there are no stale references to dynamo_cloud.md, and all relative links resolve correctly.

  • Standardize link text across docs (e.g. “Dynamo Cloud Installation” vs “Installing Dynamo Cloud”).
  • Optionally centralize the installation guide URL via a reference-style link or single permalink to reduce future churn.
examples/deployments/AKS/AKS-deployment.md (1)

93-93: Good fix; minor nit on wording alignment.

Consider aligning the visible link text with other docs (“Dynamo Cloud Installation” or “Installation Guide”) for consistency.

Also applies to: 127-127

📜 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 be48b4c and c3d3a83.

📒 Files selected for processing (4)
  • components/backends/sglang/deploy/README.md (2 hunks)
  • components/backends/trtllm/deploy/README.md (1 hunks)
  • components/backends/vllm/deploy/README.md (1 hunks)
  • examples/deployments/AKS/AKS-deployment.md (2 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). (2)
  • GitHub Check: Build and Test - vllm
  • GitHub Check: Build and Test - dynamo
🔇 Additional comments (2)
components/backends/vllm/deploy/README.md (1)

239-239: LGTM — correct relative path update.

Change is scoped and safe.

components/backends/trtllm/deploy/README.md (1)

269-269: LGTM — link target now points to installation_guide.md.

Matches the pattern used elsewhere.

@nv-nmailhot nv-nmailhot enabled auto-merge (squash) September 9, 2025 16:38
@rmccorm4
Copy link
Contributor

rmccorm4 commented Sep 9, 2025

Need to --signoff your commit for DCO check

Signed-off-by: Nate Mailhot <[email protected]>
@nv-nmailhot
Copy link
Contributor Author

Need to --signoff your commit for DCO check

done, ty

@nv-nmailhot nv-nmailhot merged commit 3ea3d59 into main Sep 9, 2025
9 of 10 checks passed
@nv-nmailhot nv-nmailhot deleted the nmailhot/fix-links branch September 9, 2025 18:17
nv-nmailhot added a commit that referenced this pull request Sep 9, 2025
nv-nmailhot added a commit that referenced this pull request Sep 9, 2025
tedzhouhk pushed a commit that referenced this pull request Sep 10, 2025
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.

3 participants