Skip to content

Conversation

nv-anants
Copy link
Contributor

@nv-anants nv-anants commented Oct 6, 2025

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 -

  • Removed symlinks from docs dir
  • Fix references to moved files

closes: OPS-1287

Summary by CodeRabbit

  • Documentation
    • Consolidated backend docs under /docs/backends for vLLM, SGLang, and TensorRT-LLM; updated links across READMEs, examples, and site includes.
    • Standardized headings and minor wording for clarity in TRT-LLM and SGLang pages.
    • Reorganized hidden toctree to surface more backend guides (multinode, multimodal, KV cache, etc.).
    • Removed outdated docs under docs/components to eliminate duplication.
    • Updated Kubernetes and metrics references to new canonical paths.
    • Improved example READMEs by pointing to current backend documentation.

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]>
@nv-anants nv-anants changed the title docs docs: move all md files from components to docs Oct 6, 2025
@github-actions github-actions bot added the docs label Oct 6, 2025
This reverts commit 640af6f.

Signed-off-by: Anant Sharma <[email protected]>
@nv-anants nv-anants marked this pull request as ready for review October 6, 2025 20:04
@nv-anants nv-anants requested review from a team as code owners October 6, 2025 20:04
Copy link
Contributor

coderabbitai bot commented Oct 6, 2025

Walkthrough

Documentation-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

Cohort / File(s) Summary
Root and Components README link updates
README.md, components/README.md
Updated links from components/backends/... to docs/backends/....
Global docs link path fixes
docs/_includes/dive_in_examples.rst, docs/_sections/backends.rst, docs/architecture/kvbm_intro.rst, docs/kubernetes/fluxcd.md, docs/kubernetes/metrics.md
Redirected references to new docs/backends/... locations; adjusted relative paths.
SGLang docs and references
docs/backends/sglang/README.md, docs/backends/sglang/gpt-oss.md, docs/backends/sglang/multimodal_epd.md, components/backends/sglang/slurm_jobs/README.md, examples/basics/multinode/README.md
Updated internal links, adjusted relative paths to architecture and deployment docs; minor wording tweaks; fixed README references.
TensorRT-LLM docs updates and formatting
components/backends/trtllm/deploy/README.md, components/backends/trtllm/performance_sweeps/README.md, docs/backends/trtllm/README.md, docs/backends/trtllm/gemma3_sliding_window_attention.md, docs/backends/trtllm/multimodal_epd.md, docs/backends/trtllm/multimodal_support.md, docs/backends/trtllm/multinode/multinode-multimodal-example.md
Pointed links to canonical docs; standardized heading levels (### → ##); minor quote/list styling normalization.
vLLM docs updates
docs/backends/vllm/README.md, docs/backends/vllm/deepseek-r1.md, docs/backends/vllm/gpt-oss.md
Updated link targets to docs/backends/vllm/...; minor phrasing cleanup; header level adjustment.
Examples link maintenance
examples/basics/disaggregated_serving/README.md, examples/basics/quickstart/README.md, examples/multimodal/README.md
Updated backend component links to new docs/backends/vllm/... paths.
Hidden toctree reorganization
docs/hidden_toctree.rst
Replaced two old entries with expanded lists for backends (trtllm, sglang, vllm); aligned with new docs layout.
Removal of legacy docs under docs/components
docs/components/backends/sglang/README.md, docs/components/backends/sglang/docs/multinode-examples.md, docs/components/backends/trtllm/README.md, docs/components/backends/trtllm/multinode/multinode-examples.md, docs/components/backends/vllm/LMCache_Integration.md, docs/components/backends/vllm/README.md
Deleted obsolete docs in docs/components/... now superseded by docs/backends/....

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

I nudge the links with twitching nose,
From burrows old to paths that rose.
Toc trees pruned, new branches sprout,
Headings hop—no code knocked out.
Docs align, the garden clean—
A happy hare in fields of green. 🐇✨

Pre-merge checks

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The pull request description follows the “Overview” section but omits the required “Details” and “Where should the reviewer start?” sections from the template and uses a nonstandard “closes: OPS-1287” line instead of the templated “Related Issues:” heading with “- closes GitHub issue: #xxx” formatting. Please add a “#### Details:” section describing the specific file moves and link updates, include a “#### Where should the reviewer start?” section pointing to key files for review, and update the “Related Issues:” heading with a properly formatted issue reference such as “- closes GitHub issue: #OPS-1287” to align with the repository’s template.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title clearly highlights the primary change of relocating markdown files from the components directory to the docs directory and includes the conventional “docs:” prefix, making it concise and specific to the main purpose of the changeset.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

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: 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 relocated docs/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

📥 Commits

Reviewing files that changed from the base of the PR and between 332482a and 795393c.

📒 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

@ishandhanani
Copy link
Contributor

@nv-anants - can we increase the scope of this PR and actually move all rst files to md?

@nv-anants
Copy link
Contributor Author

@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

Copy link
Contributor

@athreesh athreesh left a 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

@athreesh athreesh enabled auto-merge (squash) October 10, 2025 02:49
@athreesh athreesh merged commit 0a2a820 into main Oct 10, 2025
22 of 23 checks passed
@athreesh athreesh deleted the anants/components-docs branch October 10, 2025 03:39
dagil-nvidia pushed a commit that referenced this pull request Oct 10, 2025
Signed-off-by: Anant Sharma <[email protected]>
Co-authored-by: Anish <[email protected]>
Signed-off-by: Dan Gil <[email protected]>
ziqifan617 pushed a commit that referenced this pull request Oct 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.

4 participants