-
Notifications
You must be signed in to change notification settings - Fork 646
docs: move all md files from components to docs #3440
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
Conversation
Signed-off-by: Anant Sharma <[email protected]>
Signed-off-by: Anant Sharma <[email protected]>
Signed-off-by: Anant Sharma <[email protected]>
Signed-off-by: Anant Sharma <[email protected]>
Signed-off-by: Anant Sharma <[email protected]>
Signed-off-by: Anant Sharma <[email protected]>
Signed-off-by: Anant Sharma <[email protected]>
Signed-off-by: Anant Sharma <[email protected]>
Signed-off-by: Anant Sharma <[email protected]>
Signed-off-by: Anant Sharma <[email protected]>
Signed-off-by: Anant Sharma <[email protected]>
Signed-off-by: Anant Sharma <[email protected]>
This reverts commit 640af6f. Signed-off-by: Anant Sharma <[email protected]>
Signed-off-by: Anant Sharma <[email protected]>
WalkthroughDocumentation-only refactor centralizing backend links under docs/backends, updating numerous internal references, normalizing heading levels, and reorganizing the hidden toctree. Several legacy docs under docs/components/* were removed. No code, APIs, or runtime behavior changed. Changes
Sequence Diagram(s)Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
Pre-merge checks❌ 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: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/backends/trtllm/multinode/multinode-multimodal-example.md (1)
33-34
: Update the “build docker” link to the new docs path.This still points at
components/backends/trtllm
, which no longer hosts the Markdown after this migration, so the link 404s. Please retarget it to the relocateddocs/backends/trtllm#build-docker
anchor.Apply this diff:
-# https://github.com/ai-dynamo/dynamo/tree/main/components/backends/trtllm#build-docker +# https://github.com/ai-dynamo/dynamo/tree/main/docs/backends/trtllm#build-docker
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (32)
README.md
(2 hunks)components/README.md
(1 hunks)components/backends/sglang/slurm_jobs/README.md
(1 hunks)components/backends/trtllm/deploy/README.md
(3 hunks)components/backends/trtllm/performance_sweeps/README.md
(1 hunks)docs/_includes/dive_in_examples.rst
(1 hunks)docs/_sections/backends.rst
(1 hunks)docs/architecture/kvbm_intro.rst
(1 hunks)docs/backends/sglang/README.md
(3 hunks)docs/backends/sglang/gpt-oss.md
(1 hunks)docs/backends/sglang/multimodal_epd.md
(2 hunks)docs/backends/trtllm/README.md
(3 hunks)docs/backends/trtllm/gemma3_sliding_window_attention.md
(4 hunks)docs/backends/trtllm/multimodal_epd.md
(6 hunks)docs/backends/trtllm/multimodal_support.md
(6 hunks)docs/backends/trtllm/multinode/multinode-multimodal-example.md
(1 hunks)docs/backends/vllm/README.md
(2 hunks)docs/backends/vllm/deepseek-r1.md
(1 hunks)docs/backends/vllm/gpt-oss.md
(1 hunks)docs/components/backends/sglang/README.md
(0 hunks)docs/components/backends/sglang/docs/multinode-examples.md
(0 hunks)docs/components/backends/trtllm/README.md
(0 hunks)docs/components/backends/trtllm/multinode/multinode-examples.md
(0 hunks)docs/components/backends/vllm/LMCache_Integration.md
(0 hunks)docs/components/backends/vllm/README.md
(0 hunks)docs/hidden_toctree.rst
(1 hunks)docs/kubernetes/fluxcd.md
(1 hunks)docs/kubernetes/metrics.md
(2 hunks)examples/basics/disaggregated_serving/README.md
(1 hunks)examples/basics/multinode/README.md
(1 hunks)examples/basics/quickstart/README.md
(1 hunks)examples/multimodal/README.md
(6 hunks)
💤 Files with no reviewable changes (6)
- docs/components/backends/trtllm/multinode/multinode-examples.md
- docs/components/backends/trtllm/README.md
- docs/components/backends/sglang/docs/multinode-examples.md
- docs/components/backends/vllm/README.md
- docs/components/backends/vllm/LMCache_Integration.md
- docs/components/backends/sglang/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). (6)
- GitHub Check: vllm (arm64)
- GitHub Check: vllm (amd64)
- GitHub Check: trtllm (arm64)
- GitHub Check: trtllm (amd64)
- GitHub Check: sglang
- GitHub Check: Build and Test - dynamo
@nv-anants - can we increase the scope of this PR and actually move all rst files to md? |
I can do that, but will do it in a separate PR after this merges. Its already touching too many files as is |
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.
LGTM, let's double check on all potential broken links before we merge
Signed-off-by: Anant Sharma <[email protected]> Co-authored-by: Anish <[email protected]> Signed-off-by: Dan Gil <[email protected]>
Signed-off-by: Anant Sharma <[email protected]> Co-authored-by: Anish <[email protected]>
Overview:
Follow up for PR #3201. Moves all backend-specific Markdown documentation files from the components/ directory to a centralized docs/backends/ directory, improving documentation discoverability and maintainability.
Other updates -
closes: OPS-1287
Summary by CodeRabbit