352 lines
14 KiB
YAML
352 lines
14 KiB
YAML
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
# Navigation structure matching https://docs.nvidia.com/dynamo/dev/
|
|
# Rebuilt to exactly replicate the rendered Sphinx sidebar
|
|
|
|
navigation:
|
|
# ==================== Getting Started ====================
|
|
- section: Getting Started
|
|
contents:
|
|
- page: Quickstart
|
|
path: ../pages/getting-started/quickstart.md
|
|
- page: Support Matrix
|
|
path: ../pages/reference/support-matrix.md
|
|
- page: Feature Matrix
|
|
path: ../pages/reference/feature-matrix.md
|
|
- page: Release Artifacts
|
|
path: ../pages/reference/release-artifacts.md
|
|
- page: Examples
|
|
path: ../pages/getting-started/examples.md
|
|
|
|
# ==================== Kubernetes Deployment ====================
|
|
- section: Kubernetes Deployment
|
|
contents:
|
|
- section: Deployment Guide
|
|
path: ../pages/kubernetes/README.md
|
|
contents:
|
|
- page: Detailed Installation Guide
|
|
path: ../pages/kubernetes/installation-guide.md
|
|
- page: Dynamo Operator
|
|
path: ../pages/kubernetes/dynamo-operator.md
|
|
- page: Service Discovery
|
|
path: ../pages/kubernetes/service-discovery.md
|
|
- page: Webhooks
|
|
path: ../pages/kubernetes/webhooks.md
|
|
- page: Minikube Setup
|
|
path: ../pages/kubernetes/deployment/minikube.md
|
|
- page: Managing Models with DynamoModel
|
|
path: ../pages/kubernetes/deployment/dynamomodel-guide.md
|
|
- page: Autoscaling
|
|
path: ../pages/kubernetes/autoscaling.md
|
|
- page: Inference Gateway (GAIE)
|
|
path: ../pages/kubernetes/inference-gateway.md
|
|
- section: Checkpointing
|
|
path: ../pages/kubernetes/chrek/README.md
|
|
contents:
|
|
- page: Integration with Dynamo
|
|
path: ../pages/kubernetes/chrek/dynamo.md
|
|
- page: Standalone Usage
|
|
path: ../pages/kubernetes/chrek/standalone.md
|
|
- section: Observability (K8s)
|
|
contents:
|
|
- page: Metrics
|
|
path: ../pages/kubernetes/observability/metrics.md
|
|
- page: Logging
|
|
path: ../pages/kubernetes/observability/logging.md
|
|
- page: Operator Metrics
|
|
path: ../pages/kubernetes/observability/operator-metrics.md
|
|
- section: Multinode
|
|
contents:
|
|
- page: Multinode Deployments
|
|
path: ../pages/kubernetes/deployment/multinode-deployment.md
|
|
- page: Grove
|
|
path: ../pages/kubernetes/grove.md
|
|
|
|
# ==================== User Guides ====================
|
|
- section: User Guides
|
|
contents:
|
|
- page: KV Cache Aware Routing
|
|
path: ../pages/components/router/router-guide.md
|
|
- page: Disaggregated Serving
|
|
path: ../pages/features/disaggregated-serving/README.md
|
|
- page: KV Cache Offloading
|
|
path: ../pages/components/kvbm/kvbm-guide.md
|
|
- page: Dynamo Benchmarking
|
|
path: ../pages/benchmarks/benchmarking.md
|
|
- section: Multimodality Support
|
|
path: ../pages/features/multimodal/README.md
|
|
contents:
|
|
- page: vLLM Multimodal
|
|
path: ../pages/features/multimodal/multimodal-vllm.md
|
|
- page: TensorRT-LLM Multimodal
|
|
path: ../pages/features/multimodal/multimodal-trtllm.md
|
|
- page: SGLang Multimodal
|
|
path: ../pages/features/multimodal/multimodal-sglang.md
|
|
- page: Tool Calling
|
|
path: ../pages/agents/tool-calling.md
|
|
- page: LoRA Adapters
|
|
path: ../pages/features/lora/README.md
|
|
- section: Observability (Local)
|
|
path: ../pages/observability/README.md
|
|
contents:
|
|
- page: Prometheus + Grafana Setup
|
|
path: ../pages/observability/prometheus-grafana.md
|
|
- page: Metrics
|
|
path: ../pages/observability/metrics.md
|
|
- page: Metrics Developer Guide
|
|
path: ../pages/observability/metrics-developer-guide.md
|
|
- page: Health Checks
|
|
path: ../pages/observability/health-checks.md
|
|
- page: Tracing
|
|
path: ../pages/observability/tracing.md
|
|
- page: Logging
|
|
path: ../pages/observability/logging.md
|
|
- section: Fault Tolerance
|
|
path: ../pages/fault-tolerance/README.md
|
|
contents:
|
|
- page: Request Migration
|
|
path: ../pages/fault-tolerance/request-migration.md
|
|
- page: Request Cancellation
|
|
path: ../pages/fault-tolerance/request-cancellation.md
|
|
- page: Graceful Shutdown
|
|
path: ../pages/fault-tolerance/graceful-shutdown.md
|
|
- page: Request Rejection
|
|
path: ../pages/fault-tolerance/request-rejection.md
|
|
- page: Testing
|
|
path: ../pages/fault-tolerance/testing.md
|
|
- page: Writing Python Workers in Dynamo
|
|
path: ../pages/development/backend-guide.md
|
|
|
|
# ==================== Components ====================
|
|
- section: Components
|
|
contents:
|
|
- section: Backends
|
|
contents:
|
|
- page: vLLM
|
|
path: ../pages/backends/vllm/README.md
|
|
- section: SGLang
|
|
path: ../pages/backends/sglang/README.md
|
|
contents:
|
|
- page: Reference Guide
|
|
path: ../pages/backends/sglang/sglang-reference-guide.md
|
|
- page: Examples
|
|
path: ../pages/backends/sglang/sglang-examples.md
|
|
- page: Disaggregation
|
|
path: ../pages/backends/sglang/sglang-disaggregation.md
|
|
- page: Diffusion
|
|
path: ../pages/backends/sglang/sglang-diffusion.md
|
|
- page: Observability
|
|
path: ../pages/backends/sglang/sglang-observability.md
|
|
- page: TensorRT-LLM
|
|
path: ../pages/backends/trtllm/README.md
|
|
- section: Frontend
|
|
path: ../pages/components/frontend/README.md
|
|
contents:
|
|
- page: Frontend Guide
|
|
path: ../pages/components/frontend/frontend-guide.md
|
|
- section: Router
|
|
path: ../pages/components/router/README.md
|
|
contents:
|
|
- page: Router Guide
|
|
path: ../pages/components/router/router-guide.md
|
|
- page: Router Examples
|
|
path: ../pages/components/router/router-examples.md
|
|
- section: Planner
|
|
path: ../pages/components/planner/README.md
|
|
contents:
|
|
- page: Planner Guide
|
|
path: ../pages/components/planner/planner-guide.md
|
|
- page: Planner Examples
|
|
path: ../pages/components/planner/planner-examples.md
|
|
- section: Profiler
|
|
path: ../pages/components/profiler/README.md
|
|
contents:
|
|
- page: Profiler Guide
|
|
path: ../pages/components/profiler/profiler-guide.md
|
|
- page: Profiler Examples
|
|
path: ../pages/components/profiler/profiler-examples.md
|
|
- section: KVBM
|
|
path: ../pages/components/kvbm/README.md
|
|
contents:
|
|
- page: KVBM Guide
|
|
path: ../pages/components/kvbm/kvbm-guide.md
|
|
|
|
# ==================== Integrations ====================
|
|
- section: Integrations
|
|
contents:
|
|
- page: LMCache
|
|
path: ../pages/integrations/lmcache-integration.md
|
|
- page: SGLang HiCache
|
|
path: ../pages/integrations/sglang-hicache.md
|
|
- page: FlexKV
|
|
path: ../pages/integrations/flexkv-integration.md
|
|
- page: KV Events for Custom Engines
|
|
path: ../pages/integrations/kv-events-custom-engines.md
|
|
|
|
# ==================== Design Docs ====================
|
|
- section: Design Docs
|
|
contents:
|
|
- page: Overall Architecture
|
|
path: ../pages/design-docs/architecture.md
|
|
- page: Architecture Flow
|
|
path: ../pages/design-docs/dynamo-flow.md
|
|
- page: Disaggregated Serving
|
|
path: ../pages/design-docs/disagg-serving.md
|
|
- page: Distributed Runtime
|
|
path: ../pages/design-docs/distributed-runtime.md
|
|
- page: Discovery Plane
|
|
path: ../pages/design-docs/discovery-plane.md
|
|
- page: Request Plane
|
|
path: ../pages/design-docs/request-plane.md
|
|
- page: Event Plane
|
|
path: ../pages/design-docs/event-plane.md
|
|
- page: Router Design
|
|
path: ../pages/design-docs/router-design.md
|
|
- page: KVBM Design
|
|
path: ../pages/design-docs/kvbm-design.md
|
|
- page: Planner Design
|
|
path: ../pages/design-docs/planner-design.md
|
|
|
|
# ==================== Blog ====================
|
|
- section: Blog
|
|
path: ../blogs/index.mdx
|
|
slug: blog
|
|
contents:
|
|
- page: "Flash Indexer: Inter-Galactic KV Routing"
|
|
path: ../blogs/flash-indexer/flash-indexer.md
|
|
slug: flash-indexer
|
|
|
|
# ==================== Hidden Pages ====================
|
|
# Pages accessible via direct URL but not shown in main navigation.
|
|
# Matches Sphinx hidden_toctree.rst -- pages linked from within content
|
|
# but not in the sidebar.
|
|
- section: Additional Resources
|
|
hidden: true
|
|
contents:
|
|
# -- Development --
|
|
- page: Runtime Guide
|
|
path: ../pages/development/runtime-guide.md
|
|
- page: Jail Stream
|
|
path: ../pages/development/jail-stream.md
|
|
# -- API Reference --
|
|
- section: NIXL Connect API
|
|
path: ../pages/api/nixl-connect/README.md
|
|
contents:
|
|
- page: Connector
|
|
path: ../pages/api/nixl-connect/connector.md
|
|
- page: Device
|
|
path: ../pages/api/nixl-connect/device.md
|
|
- page: Device Kind
|
|
path: ../pages/api/nixl-connect/device-kind.md
|
|
- page: Descriptor
|
|
path: ../pages/api/nixl-connect/descriptor.md
|
|
- page: Read Operation
|
|
path: ../pages/api/nixl-connect/read-operation.md
|
|
- page: Write Operation
|
|
path: ../pages/api/nixl-connect/write-operation.md
|
|
- page: Readable Operation
|
|
path: ../pages/api/nixl-connect/readable-operation.md
|
|
- page: Writable Operation
|
|
path: ../pages/api/nixl-connect/writable-operation.md
|
|
- page: Operation Status
|
|
path: ../pages/api/nixl-connect/operation-status.md
|
|
- page: RDMA Metadata
|
|
path: ../pages/api/nixl-connect/rdma-metadata.md
|
|
# -- Kubernetes (hidden sub-pages) --
|
|
- page: API Reference (K8s)
|
|
path: ../pages/kubernetes/api-reference.md
|
|
- page: Creating Deployments
|
|
path: ../pages/kubernetes/deployment/create-deployment.md
|
|
- page: FluxCD
|
|
path: ../pages/kubernetes/fluxcd.md
|
|
- page: Model Caching with Fluid
|
|
path: ../pages/kubernetes/model-caching-with-fluid.md
|
|
# -- Reference --
|
|
- page: Glossary
|
|
path: ../pages/reference/glossary.md
|
|
- page: Tuning Disaggregated Performance
|
|
path: ../pages/performance/tuning.md
|
|
# -- Backend detail pages --
|
|
- section: vLLM Details
|
|
contents:
|
|
- page: DeepSeek-R1
|
|
path: ../pages/backends/vllm/deepseek-r1.md
|
|
- page: GPT-OSS
|
|
path: ../pages/backends/vllm/gpt-oss.md
|
|
- page: Multi-Node
|
|
path: ../pages/backends/vllm/multi-node.md
|
|
- page: Prometheus
|
|
path: ../pages/backends/vllm/prometheus.md
|
|
- page: Prompt Embeddings
|
|
path: ../pages/backends/vllm/prompt-embeddings.md
|
|
- page: vLLM-Omni
|
|
path: ../pages/backends/vllm/vllm-omni.md
|
|
- section: TensorRT-LLM Details
|
|
contents:
|
|
- page: Multinode Examples
|
|
path: ../pages/backends/trtllm/multinode/multinode-examples.md
|
|
- page: Llama4 + Eagle
|
|
path: ../pages/backends/trtllm/llama4-plus-eagle.md
|
|
- page: KV Cache Transfer
|
|
path: ../pages/backends/trtllm/kv-cache-transfer.md
|
|
- page: Gemma3 Sliding Window
|
|
path: ../pages/backends/trtllm/gemma3-sliding-window-attention.md
|
|
- page: GPT-OSS
|
|
path: ../pages/backends/trtllm/gpt-oss.md
|
|
- page: Prometheus
|
|
path: ../pages/backends/trtllm/prometheus.md
|
|
# -- Features (hidden sub-pages) --
|
|
- section: Speculative Decoding
|
|
path: ../pages/features/speculative-decoding/README.md
|
|
contents:
|
|
- page: Speculative Decoding with vLLM
|
|
path: ../pages/features/speculative-decoding/speculative-decoding-vllm.md
|
|
# -- Benchmarks --
|
|
- page: KV Router A/B Testing
|
|
path: ../pages/benchmarks/kv-router-ab-testing.md
|
|
# -- Mocker --
|
|
- page: Mocker
|
|
path: ../pages/mocker/mocker.md
|
|
# -- Docs README --
|
|
- page: Building Documentation
|
|
path: ../pages/README.md
|
|
# -- Templates --
|
|
- section: Templates
|
|
path: ../pages/templates/README.md
|
|
contents:
|
|
- page: Backend Guide
|
|
path: ../pages/templates/backend-guide.md
|
|
- page: Backend README
|
|
path: ../pages/templates/backend-readme.md
|
|
- page: Component Design
|
|
path: ../pages/templates/component-design.md
|
|
- page: Component Examples
|
|
path: ../pages/templates/component-examples.md
|
|
- page: Component Guide
|
|
path: ../pages/templates/component-guide.md
|
|
- page: Component README
|
|
path: ../pages/templates/component-readme.md
|
|
- page: Feature Backend
|
|
path: ../pages/templates/feature-backend.md
|
|
- page: Feature README
|
|
path: ../pages/templates/feature-readme.md
|
|
- page: In-Code README
|
|
path: ../pages/templates/incode-readme.md
|
|
- page: Infrastructure README
|
|
path: ../pages/templates/infrastructure-readme.md
|
|
- page: Integration README
|
|
path: ../pages/templates/integration-readme.md
|