Skip to content

Conversation

@dagil-nvidia
Copy link
Contributor

docs: cherry-pick documentation reorganization to release/0.6.0

Overview

This PR cherry-picks the documentation reorganization from PR #3658 (commit 598cbbb73) into the release/0.6.0 branch.

The documentation reorganization was merged to main on Oct 17, 2025, and this PR brings those changes to the 0.6.0 release branch.

Replaces: PR #3752 (closed due to base branch conflicts)

Changes

This is a cherry-pick of commit 598cbbb73 which includes:

Directory Reorganization

  • docs/API/docs/api/ (lowercase for consistency)
  • Created docs/development/ for developer-focused guides
  • Created docs/observability/ for monitoring, logging, and health checks
  • Created docs/performance/ for performance tuning guides
  • Created docs/reference/ for CLI reference, glossary, and support matrix
  • Moved docs/architecture/kvbm_*docs/kvbm/ (top-level KV Block Manager docs)
  • Moved docs/architecture/planner_*docs/planner/ (top-level Planner docs)

File Movements (53 files total)

  • docs/guides/backend.mddocs/development/backend-guide.md
  • docs/runtime/README.mddocs/development/runtime-guide.md
  • docs/guides/health_check.mddocs/observability/health-checks.md
  • docs/guides/logging.mddocs/observability/logging.md
  • docs/guides/metrics.mddocs/observability/metrics.md
  • docs/guides/disagg_perf_tuning.mddocs/performance/tuning.md
  • docs/guides/dynamo_run.mddocs/reference/cli.md
  • docs/dynamo_glossary.mddocs/reference/glossary.md
  • docs/support_matrix.mddocs/reference/support-matrix.md
  • docs/guides/tool_calling.mddocs/guides/tool-calling.md (renamed)
  • docs/architecture/run_kvbm_in_*.mddocs/kvbm/*-setup.md
  • docs/components/router/docs/router/

Updated References

  • Updated all internal documentation links in docs/index.rst
  • Updated all references in docs/hidden_toctree.rst
  • Updated links in backend READMEs
  • Updated relative paths throughout documentation

New Documentation Structure

docs/
├── api/              # API documentation (lowercase)
├── architecture/     # Core architecture docs
├── backends/         # Backend-specific guides
├── benchmarks/       # Benchmarking guides
├── development/      # Developer guides (NEW)
├── guides/           # User guides (REDUCED)
├── kubernetes/       # K8s deployment docs
├── kvbm/            # KV Block Manager docs (NEW)
├── observability/   # Monitoring, logging, health (NEW)
├── performance/     # Performance tuning (NEW)
├── planner/         # Planner-related docs (NEW)
├── reference/       # Reference materials (NEW)
└── router/          # Router documentation

Conflict Resolution

Two simple conflicts were resolved during cherry-pick:

  • components/backends/sglang/prometheus.md - Updated metrics.md path from docs/guides/ to docs/observability/
  • components/backends/vllm/prometheus.md - Updated metrics.md path from docs/guides/ to docs/observability/

Both conflicts were resolved by accepting the new documentation structure paths.

Testing

  • ✅ Cherry-picked cleanly from latest release/0.6.0 branch
  • ✅ All moved files exist in new locations
  • ✅ All toctree references are valid
  • ✅ Internal links updated
  • ✅ Conflicts resolved
  • ✅ No functional code changes

Related PRs

Checklist

  • Cherry-picked from main (commit 598cbbb73)
  • Based on latest release/0.6.0
  • Conflicts resolved
  • Documentation links verified
  • No functional code changes
  • DCO sign-off maintained from original commit
  • Ready to merge without conflicts

@dagil-nvidia dagil-nvidia requested review from a team as code owners October 20, 2025 21:26
@copy-pr-bot
Copy link

copy-pr-bot bot commented Oct 20, 2025

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.

@dagil-nvidia dagil-nvidia self-assigned this Oct 20, 2025
@github-actions github-actions bot added the docs label Oct 20, 2025
@dagil-nvidia dagil-nvidia changed the base branch from main to release/0.6.0 October 20, 2025 21:34
@github-actions
Copy link

github-actions bot commented Oct 20, 2025

📚 Documentation Preview

📖 View Latest Documentation: https://crispy-winner-3jnj38w.pages.github.io/release/0.6.0/pr-3756/

Latest Deployment:

  • Commit: 49dbdfc6 (latest push)
  • Target: release/0.6.0
  • Updated: 10/20/25, 9:57 PM UTC

Note: This link always shows the documentation for the latest commit. It may take a few minutes for GitHub Pages to update after each push.


Auto-updated by the documentation deployment workflow

@dagil-nvidia dagil-nvidia force-pushed the docs-reorg-to-release-0.6.0-v3 branch from 2a47fb1 to ca9a655 Compare October 20, 2025 21:42
@dagil-nvidia dagil-nvidia force-pushed the docs-reorg-to-release-0.6.0-v3 branch from ca9a655 to 1d65bca Compare October 20, 2025 21:43
The symlink at docs/deploy/metrics/docker-compose.yml was deleted during
the docs reorganization, but it should be kept for documentation purposes.

Updated the symlink to point to the correct location (deploy/docker-compose.yml)
since the file was moved from deploy/metrics/ to deploy/ in commit 4498a77.

Signed-off-by: Dan Gil <[email protected]>
@saturley-hall saturley-hall merged commit 76681e2 into release/0.6.0 Oct 20, 2025
12 checks passed
@saturley-hall saturley-hall deleted the docs-reorg-to-release-0.6.0-v3 branch October 20, 2025 22:09
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