docs: reorganizing documentation to make things clearer #3658

athreesh · 2025-10-15T21:46:36Z

this PR is introduced to make the documentation folder /docs clearer. it also fixes all broken links introduced by the docs reorg

Summary by CodeRabbit

Documentation
- Reorganized docs into new top-level sections (planner, kvbm, observability, performance, reference, development) and updated navigation/toctrees.
- Updated many internal links (SLA/Load Planners, KVBM, Support Matrix, metrics, Quickstarts) to new planner/ref paths.
- Clarified router state descriptions in architecture docs.
- No functional code changes.

copy-pr-bot · 2025-10-15T21:46:39Z

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

coderabbitai · 2025-10-15T21:46:49Z

Walkthrough

Documentation reorganization and link-path updates across READMEs and docs: planner content moved to docs/planner/, KVBM to docs/kvbm/, metrics to docs/observability/*, support matrix to docs/reference/support-matrix.md; toctrees updated; new reorg/migration guides added; an obsolete docker-compose doc reference removed.

Changes

Cohort / File(s)	Summary
Top-level README(s) `README.md`, `components/backends/vllm/deploy/README.md`, `components/src/dynamo/planner/README.md`	Updated documentation links to use new `planner/`, `kvbm/`, and `reference/` paths; no functional changes.
Reorg Plans & Guides `docs/REORG_SUMMARY.md`, `docs/RESTRUCTURE_PLAN.md`, `docs/URL_MIGRATION_GUIDE.md`	Added/updated documents describing docs reorganization, URL migration mappings, testing, rollback, and execution plan.
Architecture docs `docs/architecture/architecture.md`, `docs/architecture/kv_cache_routing.md`	Adjusted cross-links to `../planner/` and `../kvbm/`; added router state note and an "Active blocks (decoding blocks)" state.
Backends READMEs `docs/backends/sglang/README.md`, `docs/backends/trtllm/README.md`, `docs/backends/vllm/README.md`	Redirected SLA/Load Planner and KVBM links from `architecture/` to `planner/` and `kvbm/*`.
Benchmarks `docs/benchmarks/pre_deployment_profiling.md`	Updated SLA Planner Quickstart links to `docs/planner/sla_planner_quickstart.md`.
Kubernetes docs `docs/kubernetes/installation_guide.md`, `docs/kubernetes/metrics.md`	Updated SLA planner quickstart path and metrics reference to `observability/metrics.md`.
KVBM setup `docs/kvbm/trtllm-setup.md`, `docs/kvbm/vllm-setup.md`	Updated KVBM intro links from `architecture` to `kvbm` paths.
Planner docs `docs/planner/planner_intro.rst`, `docs/planner/sla_planner.md`, `docs/planner/sla_planner_quickstart.md`	Normalized internal cross-references and quickstart links to planner-local paths.
TOC / Navigation `docs/index.rst`, `docs/hidden_toctree.rst`	Repointed toctree entries to new directories (`reference`, `observability`, `planner`, `kvbm`, `development`).
Removed artifact `docs/deploy/metrics/docker-compose.yml`	Deleted obsolete documentation reference file.

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

docs: move all md files from components to docs #3440 — Overlapping repository-wide docs reorganization and link/path normalization affecting backend and planner documentation.

Poem

A bunny hops through docs tonight,
Paths realigned, links set just right.
From planner burrows to KVBM glen,
Trails now tidy for every den.
I twitch my nose—no broken tracks—
Carrots for routes and tidy stacks. 🥕✨

Pre-merge checks

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The pull request description does not follow the required template because it lacks the structured sections (Overview, Details, Where should the reviewer start, and Related Issues) specified in the repository’s description_template.	Please update the description to include the template headings: provide an Overview of the reorganization, Details of the changes made, guidance on where the reviewer should start reviewing, and any related issue references under the Related Issues section.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title succinctly describes the primary change by indicating that the documentation is being reorganized for clarity, which aligns directly with the extensive doc reorganization and link updates in this PR.
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.}

- Rename API/ → api/ for consistency - Create observability/, performance/, development/, reference/ sections - Move guides/ content to appropriate sections: * observability/: health-checks, logging, metrics * development/: backend-guide, runtime-guide * performance/: tuning * backends/: kvbm-setup guides * reference/: CLI, glossary, support-matrix - Keep guides/tool-calling.md (genuine how-to) - Remove empty runtime/ and deploy/ directories Signed-off-by: athreesh <[email protected]>

- Update API/ → api/ references - Update guides/* → new locations (observability/, development/, performance/, reference/) - Update index.rst navigation with new paths - Update hidden_toctree.rst with new paths - Update cross-references in kubernetes/metrics.md Signed-off-by: athreesh <[email protected]>

Signed-off-by: athreesh <[email protected]>

- Create top-level kvbm/ directory with all KVBM content * Architecture docs from architecture/kvbm_*.md * Setup guides from backends/*/kvbm-setup.md → kvbm/*-setup.md - Create top-level planner/ directory * Move planner docs from architecture/ - Move router/ out of components/ to top level - Remove empty components/ directory - Update all internal links and navigation Signed-off-by: athreesh <[email protected]>

Signed-off-by: athreesh <[email protected]>

Update all documentation links to reflect the new structure where kvbm/, planner/, and router/ directories have been moved to the top level of the docs folder. Changes: - Move docs/kubernetes/sla_planner_quickstart.md to docs/planner/ - Update all references from /docs/kubernetes/sla_planner_quickstart to /docs/planner/sla_planner_quickstart (8 files) - Update references from /docs/architecture/planner_intro to /docs/planner/planner_intro (2 files) - Update references from /docs/architecture/kvbm_intro to /docs/kvbm/kvbm_intro (1 file) - Fix critical Sphinx toctree reference in docs/index.rst - Remove temporary analysis files (DOCS_ANALYSIS.md, FINAL_STRUCTURE.md) All documentation links now correctly point to the reorganized structure. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]> Signed-off-by: athreesh <[email protected]>

coderabbitai

Actionable comments posted: 4

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

docs/architecture/architecture.md (1)
157-162: Restore the router doc path to the components directory.

Line 157 now links to ../router/README.md, but the router documentation still lives under docs/components/router/README.md. The new relative path will 404 in both GitHub and the generated docs. Please point the link back at the components location (or move the doc accordingly).
-See [KV Router Architecture](../router/README.md) for details.
+See [KV Router Architecture](../components/router/README.md) for details.

🧹 Nitpick comments (1)

docs/kvbm/vllm-setup.md (1)
22-22: Make the link text descriptive.

“here” isn’t accessible—screen readers can’t convey the destination. Use meaningful text instead.
-To learn what KVBM is, please check [here](https://docs.nvidia.com/dynamo/latest/kvbm/kvbm_intro.html)
+To learn what KVBM is, see the [KVBM overview](https://docs.nvidia.com/dynamo/latest/kvbm/kvbm_intro.html)

📜 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 43d687e and 013aa24.

📒 Files selected for processing (22)

README.md (2 hunks)
components/backends/vllm/deploy/README.md (1 hunks)
components/src/dynamo/planner/README.md (1 hunks)
docs/REORG_SUMMARY.md (1 hunks)
docs/RESTRUCTURE_PLAN.md (1 hunks)
docs/URL_MIGRATION_GUIDE.md (1 hunks)
docs/architecture/architecture.md (1 hunks)
docs/architecture/kv_cache_routing.md (2 hunks)
docs/backends/sglang/README.md (1 hunks)
docs/backends/trtllm/README.md (1 hunks)
docs/backends/vllm/README.md (1 hunks)
docs/benchmarks/pre_deployment_profiling.md (2 hunks)
docs/deploy/metrics/docker-compose.yml (0 hunks)
docs/hidden_toctree.rst (2 hunks)
docs/index.rst (2 hunks)
docs/kubernetes/installation_guide.md (1 hunks)
docs/kubernetes/metrics.md (1 hunks)
docs/kvbm/trtllm-setup.md (1 hunks)
docs/kvbm/vllm-setup.md (1 hunks)
docs/planner/planner_intro.rst (2 hunks)
docs/planner/sla_planner.md (2 hunks)
docs/planner/sla_planner_quickstart.md (1 hunks)

💤 Files with no reviewable changes (1)

docs/deploy/metrics/docker-compose.yml

🧰 Additional context used

🪛 GitHub Actions: Generate Documentation

docs/REORG_SUMMARY.md

[error] 24-24: Document or section may not begin with a transition. (docutils)

🪛 LanguageTool

docs/URL_MIGRATION_GUIDE.md

[grammar] ~3-~3: There might be a mistake here.
Context: ...ration Guide Date: October 15, 2025 Branch: docs-reorg This document tr...

(QB_NEW_EN)

[grammar] ~20-~20: There might be a mistake here.
Context: ...tories | Old Path | New Path | Reason | |----------|----------|--------| | `/doc...

(QB_NEW_EN)

[grammar] ~21-~21: There might be a mistake here.
Context: ...eason | |----------|----------|--------| | /docs/API/ | /docs/api/ | Consiste...

(QB_NEW_EN)

[grammar] ~34-~34: There might be a mistake here.
Context: ...untime/- Content moved to development/ - Most of/docs/guides/` - Content distri...

(QB_NEW_EN)

[grammar] ~46-~46: There might be a mistake here.
Context: ...xl_connect/*.md ``` Impact: 11 files Action: Update any links to use lowe...

(QB_NEW_EN)

[grammar] ~63-~63: There might be a mistake here.
Context: ...*: 3 files moved, 1 renamed (kebab-case) Note: Kubernetes-specific metrics/lo...

(QB_NEW_EN)

[grammar] ~77-~77: There might be a mistake here.
Context: ...runtime-guide.md ``` Impact: 2 files Audience: Backend developers --- #...

(QB_NEW_EN)

[grammar] ~88-~88: There might be a mistake here.
Context: ...ormance/tuning.md ``` Impact: 1 file Note: Shorter, clearer name --- ##...

(QB_NEW_EN)

[grammar] ~102-~102: There might be a mistake here.
Context: .../trtllm-setup.md ``` Impact: 2 files Reason: Co-located with backend docu...

(QB_NEW_EN)

[grammar] ~119-~119: There might be a mistake here.
Context: ...upport-matrix.md ``` Impact: 3 files Note: Clearer categorization as refe...

(QB_NEW_EN)

[grammar] ~130-~130: There might be a mistake here.
Context: ...t**: 1 file (only renamed to kebab-case) Reason: Genuine how-to guide, stays ...

(QB_NEW_EN)

[grammar] ~139-~139: There might be a mistake here.
Context: ...) Updated paths in the main navigation: - Support Matrix: support_matrix.md → `r...

(QB_NEW_EN)

[grammar] ~140-~140: There might be a mistake here.
Context: ...- Support Matrix: support_matrix.md → reference/support-matrix.md - Logging: guides/logging.md → `observab...

(QB_NEW_EN)

[grammar] ~141-~141: There might be a mistake here.
Context: ...ix.md- Logging:guides/logging.md→observability/logging.md- Health Checks:guides/health_check.md` ...

(QB_NEW_EN)

[grammar] ~142-~142: There might be a mistake here.
Context: ...alth Checks: guides/health_check.md → observability/health-checks.md - Performance Tuning: `guides/disagg_perf_...

(QB_NEW_EN)

[grammar] ~143-~143: There might be a mistake here.
Context: ...uning: guides/disagg_perf_tuning.md → performance/tuning.md - Backend Guide: guides/backend.md → `de...

(QB_NEW_EN)

[grammar] ~144-~144: There might be a mistake here.
Context: ... - Backend Guide: guides/backend.md → development/backend-guide.md - Glossary: dynamo_glossary.md → `refere...

(QB_NEW_EN)

[grammar] ~149-~149: There might be a mistake here.
Context: ...den_toctree.rst) Updated references to: - All API/ → api/ paths - `runtime/REA...

(QB_NEW_EN)

[grammar] ~212-~212: There might be a mistake here.
Context: ... have questions about the new structure: 1. Check this migration guide first 2. Sear...

(QB_NEW_EN)

components/backends/vllm/deploy/README.md

[grammar] ~240-~240: There might be a mistake here.
Context: ...Planner**: SLA Planner Quickstart Guide - Examples: [Deployment Examples](../../...

(QB_NEW_EN)

docs/backends/trtllm/README.md

[grammar] ~58-~58: There might be a mistake here.
Context: ...../docs/planner/sla_planner.md) | ✅ | | | [Load Based Planner](../../../docs...

(QB_NEW_EN)

[grammar] ~59-~59: There might be a mistake here.
Context: ...lanner/load_planner.md) | 🚧 | Planned | | [KVBM](../../../docs/kvbm/kvbm_arc...

(QB_NEW_EN)

[grammar] ~60-~60: There might be a mistake here.
Context: ...m/kvbm_architecture.md) | 🚧 | Planned | ### Large Scale P/D and WideEP Features | F...

(QB_NEW_EN)

docs/architecture/architecture.md

[grammar] ~57-~57: There might be a mistake here.
Context: ...ing.md) - Dynamo KV Cache Block Manager - Planner -...

(QB_NEW_EN)

[grammar] ~58-~58: There might be a mistake here.
Context: ...ager](../kvbm/kvbm_intro.rst) - Planner - [NVIDIA Inference Transfer Library (NIXL)...

(QB_NEW_EN)

docs/REORG_SUMMARY.md

[grammar] ~3-~3: There might be a mistake here.
Context: ...tion - Summary Branch: docs-reorg Date: October 15, 2025 Status: ✅...

(QB_NEW_EN)

[grammar] ~4-~4: There might be a mistake here.
Context: ... docs-reorg Date: October 15, 2025 Status: ✅ Complete --- ## What Was...

(QB_NEW_EN)

[grammar] ~17-~17: There might be a mistake here.
Context: ...# Changes Summary ### Files Changed: 30 - 24 files moved/renamed to new location...

(QB_NEW_EN)

[grammar] ~18-~18: There might be a mistake here.
Context: ...4 files moved/renamed** to new locations - 3 new planning/analysis documents crea...

(QB_NEW_EN)

[grammar] ~19-~19: There might be a mistake here.
Context: ...ew planning/analysis documents** created - 3 navigation files updated (index.rst,...

(QB_NEW_EN)

[grammar] ~28-~28: There might be a mistake here.
Context: ...ovements ### 1. Consistent Naming ✅ - Renamed API/ → api/ (lowercase consi...

(QB_NEW_EN)

[grammar] ~29-~29: There might be a mistake here.
Context: ... API/ → api/ (lowercase consistency) - Standardized guide names to kebab-case ...

(QB_NEW_EN)

[grammar] ~32-~32: There might be a mistake here.
Context: ...-case ### 2. Logical Organization ✅ Created 4 new logical sections: - `obser...

(QB_NEW_EN)

[grammar] ~39-~39: There might be a mistake here.
Context: ...## 3. Cleaned Up Scattered Content ✅ - Distributed guides/ (9 files) to appro...

(QB_NEW_EN)

[grammar] ~41-~41: There might be a mistake here.
Context: ...ved backend-specific guides to backends/ - Consolidated reference material - Remove...

(QB_NEW_EN)

[grammar] ~45-~45: There might be a mistake here.
Context: ...ectories ### 4. Updated All Links ✅ - Updated ~50+ internal links throughout d...

(QB_NEW_EN)

[grammar] ~86-~86: There might be a mistake here.
Context: ...ructure - move files to logical sections 2. 7f021d2 - docs: Update all internal li...

(QB_NEW_EN)

[grammar] ~87-~87: There might be a mistake here.
Context: ...date all internal links to new structure 3. 6a2401d - docs: Fix hidden_toctree.rst...

(QB_NEW_EN)

[grammar] ~88-~88: There might be a mistake here.
Context: ...d** - docs: Fix hidden_toctree.rst paths 4. d9507b2 - docs: Add URL migration guid...

(QB_NEW_EN)

[grammar] ~97-~97: There might be a mistake here.
Context: ... files ✅ Maintainable - New content has obvious home ✅ Scalable - Structure...

(QB_NEW_EN)

[grammar] ~105-~105: There might be a mistake here.
Context: ...lysis of original structure and problems 2. RESTRUCTURE_PLAN.md - Detailed executi...

(QB_NEW_EN)

[grammar] ~106-~106: There might be a mistake here.
Context: ...TURE_PLAN.md** - Detailed execution plan 3. URL_MIGRATION_GUIDE.md - Guide for ext...

(QB_NEW_EN)

[grammar] ~107-~107: There might be a mistake here.
Context: ... for external maintainers updating links 4. REORG_SUMMARY.md (this file) - Summary...

(QB_NEW_EN)

[grammar] ~114-~114: There might be a mistake here.
Context: ...les moved successfully (no lost content) - ✅ All internal links updated - ✅ Navigat...

(QB_NEW_EN)

[grammar] ~115-~115: There might be a mistake here.
Context: ... content) - ✅ All internal links updated - ✅ Navigation files updated - ⚠️ Sphinx b...

(QB_NEW_EN)

[grammar] ~116-~116: There might be a mistake here.
Context: ...nks updated - ✅ Navigation files updated - ⚠️ Sphinx build requires dependencies (n...

(QB_NEW_EN)

[grammar] ~161-~161: There might be a mistake here.
Context: ... identified - See RESTRUCTURE_PLAN.md for detailed execution plan - See `URL_MIGR...

(QB_NEW_EN)

docs/backends/sglang/README.md

[grammar] ~40-~40: There might be a mistake here.
Context: ...](../../planner/sla_planner.md) | ✅ | | | [Multimodal EPD Disaggregation](mu...

(QB_NEW_EN)

[grammar] ~41-~41: There might be a mistake here.
Context: ...gregation**](multimodal_epd.md) | ✅ | | | [KVBM](../../kvbm/kvbm_architectur...

(QB_NEW_EN)

[grammar] ~42-~42: There might be a mistake here.
Context: ...bm/kvbm_architecture.md) | ❌ | Planned | ## Dynamo SGLang Integration Dynamo SGLang...

(QB_NEW_EN)

docs/RESTRUCTURE_PLAN.md

[grammar] ~10-~10: There might be a mistake here.
Context: ...Inconsistent Naming: API/ (uppercase)* - Only directory with uppercase naming - S...

(QB_NEW_EN)

[grammar] ~14-~14: There might be a mistake here.
Context: ... guides/ (9 files belonging elsewhere)** Current guides and where they should go:...

(QB_NEW_EN)

[grammar] ~32-~32: There might be a mistake here.
Context: ...le places: | File | Location | Action | |------|----------|--------| | `observab...

(QB_NEW_EN)

[grammar] ~33-~33: There might be a mistake here.
Context: ... | Action | |------|----------|--------| | observability/metrics.md | General m...

(QB_NEW_EN)

[grammar] ~34-~34: There might be a mistake here.
Context: ...trics guide | Move to observability/ | | kubernetes/metrics.md | K8s-specific...

(QB_NEW_EN)

[grammar] ~35-~35: There might be a mistake here.
Context: ...specific metrics | Keep in kubernetes/ | | observability/logging.md | General l...

(QB_NEW_EN)

[grammar] ~36-~36: There might be a mistake here.
Context: ...gging guide | Move to observability/ | | kubernetes/logging.md | K8s-specific...

(QB_NEW_EN)

[grammar] ~37-~37: There might be a mistake here.
Context: ...specific logging | Keep in kubernetes/ | | observability/health-checks.md | Hea...

(QB_NEW_EN)

[grammar] ~40-~40: There might be a mistake here.
Context: ...| ### 4. Thin components/ Directory - Only has router/ with 1 README - Missi...

(QB_NEW_EN)

[grammar] ~44-~44: There might be a mistake here.
Context: ...e/) ### 5. **Empty deploy/` Directory** - Has no docs at top level - Only contains...

(QB_NEW_EN)

[grammar] ~51-~51: There might be a mistake here.
Context: ... - reference/support-matrix.md at root - Should be organized under reference/ ...

(QB_NEW_EN)

[grammar] ~191-~191: There might be a mistake here.
Context: ...en_toctree.rst- Hidden page references 3. All files inbackends/` that reference ...

(QB_NEW_EN)

[grammar] ~192-~192: There might be a mistake here.
Context: ...les in backends/ that reference guides 4. All files in kubernetes/ that referenc...

(QB_NEW_EN)

[grammar] ~193-~193: There might be a mistake here.
Context: ...s in kubernetes/ that reference guides 5. Files that cross-reference glossary/supp...

(QB_NEW_EN)

[grammar] ~214-~214: There might be a mistake here.
Context: ...tent naming**: All lowercase directories 2. ✅ Logical organization: Content grou...

(QB_NEW_EN)

[grammar] ~215-~215: There might be a mistake here.
Context: ...ganization**: Content grouped by purpose 3. ✅ Clear observability section: All m...

(QB_NEW_EN)

[grammar] ~216-~216: There might be a mistake here.
Context: ... section**: All monitoring docs together 4. ✅ Better reference section: CLI, glo...

(QB_NEW_EN)

[grammar] ~217-~217: There might be a mistake here.
Context: ... CLI, glossary, support matrix organized 5. ✅ Cleaner backends/: Backend-specifi...

(QB_NEW_EN)

[grammar] ~218-~218: There might be a mistake here.
Context: ... Backend-specific features with backends 6. ✅ No premature abstraction: Keeping ...

(QB_NEW_EN)

[grammar] ~219-~219: There might be a mistake here.
Context: ...eeping kubernetes/ at root (appropriate) 7. ✅ Removed clutter: Empty deploy/ and...

(QB_NEW_EN)

[grammar] ~226-~226: There might be a mistake here.
Context: ...les moved successfully (no lost content) - [ ] Run Sphinx build: `cd docs && python...

(QB_NEW_EN)

[grammar] ~227-~227: There might be a mistake here.
Context: ...o lost content) - [ ] Run Sphinx build: cd docs && python generate_docs.py - [ ] No build warnings/errors - [ ] Spot-...

(QB_NEW_EN)

[grammar] ~228-~228: There might be a mistake here.
Context: ..._docs.py` - [ ] No build warnings/errors - [ ] Spot-check 5-10 key pages in browser...

(QB_NEW_EN)

[grammar] ~229-~229: There might be a mistake here.
Context: ...[ ] Spot-check 5-10 key pages in browser - [ ] Verify navigation works in built HTM...

(QB_NEW_EN)

[grammar] ~230-~230: There might be a mistake here.
Context: ... ] Verify navigation works in built HTML - [ ] Check links to moved pages --- ## ...

(QB_NEW_EN)

[grammar] ~250-~250: There might be a mistake here.
Context: ...Execution Time - Directory moves: 5 min - Link updates: 15 min - Navigation update...

(QB_NEW_EN)

[grammar] ~251-~251: There might be a mistake here.
Context: ...tory moves: 5 min - Link updates: 15 min - Navigation updates: 5 min - Testing: 10 ...

(QB_NEW_EN)

[grammar] ~252-~252: There might be a mistake here.
Context: ...ates: 15 min - Navigation updates: 5 min - Testing: 10 min - Total: ~35 minutes...

(QB_NEW_EN)

[grammar] ~253-~253: There might be a mistake here.
Context: ...igation updates: 5 min - Testing: 10 min - Total: ~35 minutes --- ## Next Steps...

(QB_NEW_EN)

[grammar] ~264-~264: There might be a mistake here.
Context: ...its at key checkpoints 4. Test build 5. Create summary of URL changes for external mai...

(QB_NEW_EN)

docs/backends/vllm/README.md

[grammar] ~41-~41: There might be a mistake here.
Context: ...../docs/planner/sla_planner.md) | ✅ | | | [Load Based Planner](../../../docs...

(QB_NEW_EN)

[grammar] ~42-~42: There might be a mistake here.
Context: ...cs/planner/load_planner.md) | 🚧 | WIP | | [KVBM](../../../docs/kvbm/kvbm_arc...

(QB_NEW_EN)

[grammar] ~43-~43: There might be a mistake here.
Context: ...docs/kvbm/kvbm_architecture.md) | ✅ | | | [LMCache](./LMCache_Integration.md...

(QB_NEW_EN)

🪛 markdownlint-cli2 (0.18.1)

docs/URL_MIGRATION_GUIDE.md

42-42: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

53-53: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

70-70: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

84-84: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

95-95: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

109-109: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

126-126: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

214-214: Bare URL used

(MD034, no-bare-urls)

215-215: Bare URL used

(MD034, no-bare-urls)

docs/kvbm/vllm-setup.md

22-22: Link text should be descriptive

(MD059, descriptive-link-text)

docs/RESTRUCTURE_PLAN.md

55-55: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

⏰ 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). (1)

GitHub Check: Build and Test - dynamo

components/src/dynamo/planner/README.md

docs/REORG_SUMMARY.md

docs/RESTRUCTURE_PLAN.md

README.md

Fix relative path in components/src/dynamo/planner/README.md to correctly resolve to docs/planner/planner_intro.rst from the repo root. The path ../../docs/planner resolves to components/src/docs/planner which doesn't exist. Updated to ../../../../docs/planner to properly navigate from components/src/dynamo/planner back to repo root. Signed-off-by: athreesh <[email protected]>

Fix repository-relative links in README.md to work correctly on GitHub. Links with /docs/... resolve to https://github.com/docs/... and break. Changed to docs/... for proper relative resolution. Fixes: - /docs/planner/load_planner.md -> docs/planner/load_planner.md - /docs/planner/sla_planner.md -> docs/planner/sla_planner.md - /docs/kvbm/kvbm_architecture.md -> docs/kvbm/kvbm_architecture.md Signed-off-by: athreesh <[email protected]>

Update all broken links to reflect the new documentation structure: Metrics and Logging: - docs/guides/metrics.md → docs/observability/metrics.md (4 files) - docs/guides/logging.md → docs/observability/logging.md (1 file) Backend and Development: - backend.md → ../development/backend-guide.md (3 files) - docs/runtime/README.md → docs/development/runtime-guide.md (1 file) CLI and KVBM: - docs/guides/dynamo_run.md → docs/reference/cli.md (1 file) - docs/guides/run_kvbm_in_trtllm.md → docs/kvbm/trtllm-setup.md (1 file) Files updated: - components/backends/sglang/prometheus.md (2 instances) - components/backends/vllm/prometheus.md (2 instances) - deploy/metrics/README.md - deploy/tracing/README.md - docs/backends/trtllm/README.md - docs/kubernetes/create_deployment.md - docs/observability/health-checks.md - docs/observability/logging.md - docs/observability/metrics.md - lib/bindings/python/README.md Cleanup: - Remove temporary reorganization documentation files (REORG_SUMMARY.md, RESTRUCTURE_PLAN.md, URL_MIGRATION_GUIDE.md) All documentation links now correctly reference the reorganized structure. Signed-off-by: athreesh <[email protected]>

… docs-reorg

athreesh · 2025-10-16T21:32:07Z

/ok to test 9123999

Resolved conflicts in prometheus.md files by keeping docs-reorg structure. Signed-off-by: athreesh <[email protected]>

athreesh · 2025-10-16T22:54:01Z

/ok to test 464ce16

copy-pr-bot · 2025-10-16T22:54:04Z

/ok to test 464ce16

@athreesh, there was an error processing your request: E2

See the following link for more information: https://docs.gha-runners.nvidia.com/cpr/e/2/

athreesh · 2025-10-16T23:03:26Z

/ok to test b7c8dab

copy-pr-bot · 2025-10-16T23:03:29Z

/ok to test b7c8dab

@athreesh, there was an error processing your request: E2

See the following link for more information: https://docs.gha-runners.nvidia.com/cpr/e/2/

athreesh · 2025-10-16T23:10:51Z

/ok to test 2eddc2b

Signed-off-by: athreesh <[email protected]> Co-authored-by: Claude <[email protected]>

Signed-off-by: athreesh <[email protected]> Co-authored-by: Claude <[email protected]> Signed-off-by: Dan Gil <[email protected]>

athreesh requested review from a team as code owners October 15, 2025 21:46

pull-request-size bot added the size/XL label Oct 15, 2025

github-actions bot added the docs label Oct 15, 2025

athreesh and others added 8 commits October 15, 2025 14:51

docs: Fix hidden_toctree.rst paths

1031848

Signed-off-by: athreesh <[email protected]>

docs: Add URL migration guide for external maintainers

a4bd70e

Signed-off-by: athreesh <[email protected]>

docs: Add reorganization summary

798c337

Signed-off-by: athreesh <[email protected]>

docs: Add final structure documentation

50321ff

Signed-off-by: athreesh <[email protected]>

athreesh force-pushed the docs-reorg branch from 42aa161 to 013aa24 Compare October 15, 2025 21:52

coderabbitai bot reviewed Oct 15, 2025

View reviewed changes

components/src/dynamo/planner/README.md Outdated Show resolved Hide resolved

docs/REORG_SUMMARY.md Outdated Show resolved Hide resolved

docs/RESTRUCTURE_PLAN.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

athreesh added 3 commits October 15, 2025 14:59

athreesh requested a review from a team as a code owner October 15, 2025 22:08

pull-request-size bot added size/L and removed size/XL labels Oct 15, 2025

athreesh and others added 2 commits October 15, 2025 15:27

Merge branch 'main' into docs-reorg

4e00ecc

Merge branch 'main' into docs-reorg

7d69a60

athreesh enabled auto-merge (squash) October 15, 2025 22:29

athreesh and others added 2 commits October 15, 2025 17:15

Merge branch 'main' into docs-reorg

23c6273

Merge branch 'docs-reorg' of https://github.com/ai-dynamo/dynamo into…

cc220c6

… docs-reorg

tmonty12 approved these changes Oct 16, 2025

View reviewed changes

Merge remote-tracking branch 'origin/main' into docs-reorg

c62ac73

pull-request-size bot added size/XL size/L and removed size/L size/XL labels Oct 16, 2025

athreesh force-pushed the docs-reorg branch from b7c8dab to 8396fac Compare October 16, 2025 22:45

pull-request-size bot added size/XXL size/L and removed size/L size/XXL labels Oct 16, 2025

copy-pr-bot bot temporarily deployed to GITLAB October 16, 2025 22:49 Inactive

Merge branch 'main' into docs-reorg

464ce16

Resolved conflicts in prometheus.md files by keeping docs-reorg structure. Signed-off-by: athreesh <[email protected]>

athreesh force-pushed the docs-reorg branch from 2efbdb5 to 464ce16 Compare October 16, 2025 22:52

Merge branch 'main' into docs-reorg

2eddc2b

copy-pr-bot bot temporarily deployed to GITLAB October 16, 2025 23:10 Inactive

copy-pr-bot bot temporarily deployed to GITLAB October 16, 2025 23:15 Inactive

athreesh merged commit 598cbbb into main Oct 17, 2025
24 of 25 checks passed

athreesh deleted the docs-reorg branch October 17, 2025 00:00

ziqifan617 pushed a commit that referenced this pull request Oct 20, 2025

docs: reorganizing documentation to make things clearer (#3658)

32b7e28

Signed-off-by: athreesh <[email protected]> Co-authored-by: Claude <[email protected]>

dagil-nvidia pushed a commit that referenced this pull request Oct 20, 2025

docs: reorganizing documentation to make things clearer (#3658)

7d41776

Signed-off-by: athreesh <[email protected]> Co-authored-by: Claude <[email protected]>

dagil-nvidia mentioned this pull request Oct 20, 2025

docs: reorg to release 0.6.0 v2 #3752

Closed

5 tasks

dagil-nvidia pushed a commit that referenced this pull request Oct 20, 2025

docs: reorganizing documentation to make things clearer (#3658)

18cc6ad

Signed-off-by: athreesh <[email protected]> Co-authored-by: Claude <[email protected]>

This was referenced Oct 20, 2025

docs: cherry-pick documentation reorganization to release/0.6.0 #3756

Merged

docs: cherry-pick documentation reorganization to release/0.6.0 #3757

Closed

dagil-nvidia pushed a commit that referenced this pull request Oct 20, 2025

docs: reorganizing documentation to make things clearer (#3658)

ca9a655

Signed-off-by: athreesh <[email protected]> Co-authored-by: Claude <[email protected]>

dagil-nvidia pushed a commit that referenced this pull request Oct 20, 2025

docs: reorganizing documentation to make things clearer (#3658)

1d65bca

Signed-off-by: athreesh <[email protected]> Co-authored-by: Claude <[email protected]> Signed-off-by: Dan Gil <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: reorganizing documentation to make things clearer #3658

docs: reorganizing documentation to make things clearer #3658

Uh oh!

athreesh commented Oct 15, 2025 •

edited

Loading

Uh oh!

copy-pr-bot bot commented Oct 15, 2025

Uh oh!

coderabbitai bot commented Oct 15, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

athreesh commented Oct 16, 2025

Uh oh!

athreesh commented Oct 16, 2025

Uh oh!

copy-pr-bot bot commented Oct 16, 2025

Uh oh!

athreesh commented Oct 16, 2025

Uh oh!

copy-pr-bot bot commented Oct 16, 2025

Uh oh!

athreesh commented Oct 16, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

docs: reorganizing documentation to make things clearer #3658

docs: reorganizing documentation to make things clearer #3658

Uh oh!

Conversation

athreesh commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

copy-pr-bot bot commented Oct 15, 2025

Uh oh!

coderabbitai bot commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Poem

Pre-merge checks

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

athreesh commented Oct 16, 2025

Uh oh!

athreesh commented Oct 16, 2025

Uh oh!

copy-pr-bot bot commented Oct 16, 2025

Uh oh!

athreesh commented Oct 16, 2025

Uh oh!

copy-pr-bot bot commented Oct 16, 2025

Uh oh!

athreesh commented Oct 16, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

athreesh commented Oct 15, 2025 •

edited

Loading

coderabbitai bot commented Oct 15, 2025 •

edited

Loading