-
Notifications
You must be signed in to change notification settings - Fork 690
docs: fix broken links #2965
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: fix broken links #2965
Conversation
WalkthroughUpdated documentation links in four README/guide files to point from dynamo_cloud.md to installation_guide.md. No code or behavior changes. Changes
Sequence Diagram(s)Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
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.
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)
✅ Passed checks (2 passed)
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. Comment |
There was a problem hiding this 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
📒 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.
|
Need to |
Signed-off-by: Nate Mailhot <[email protected]>
c3d3a83 to
19ce49e
Compare
done, ty |
Signed-off-by: hongkuanz <[email protected]>
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)
Summary by CodeRabbit