Skip to content

GitLab

Switch branch/tag
Find file Normal viewHistoryPermalink
next.yml 12.3 KB
Newer Older
Jonathan Tong's avatar
docs: migrate existing docs to fern (#5445)  
Jonathan Tong committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28 
# 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 for Latest version
# Matching https://docs.nvidia.com/dynamo/latest/

navigation:
  # ==================== Getting Started ====================
  - section: Getting Started
    contents:
      - page: Quickstart
        path: ../pages/getting-started/quickstart.md
      - page: Installation
        path: ../pages/getting-started/installation.md
      - page: Support Matrix
        path: ../pages/reference/support-matrix.md
Jonathan Tong's avatar
docs: update Fern docs for main branch (#5706)  
Jonathan Tong committed
29
30
31
32 
      - page: Feature Matrix
        path: ../pages/reference/feature-matrix.md
      - page: Release Artifacts
        path: ../pages/reference/release-artifacts.md
Jonathan Tong's avatar
docs: migrate existing docs to fern (#5445)  
Jonathan Tong committed
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50 
      - page: Examples
        path: ../pages/getting-started/examples.md

  # ==================== Kubernetes Deployment ====================
  - section: Kubernetes Deployment
    contents:
      - section: Deployment Guide
        contents:
          - page: Kubernetes Quickstart
            path: ../pages/kubernetes/README.md
          - page: Detailed Installation Guide
            path: ../pages/kubernetes/installation-guide.md
          - page: Dynamo Operator
            path: ../pages/kubernetes/dynamo-operator.md
          - page: Minikube Setup
            path: ../pages/kubernetes/deployment/minikube-setup.md
          - page: Managing Models with DynamoModel
            path: ../pages/kubernetes/deployment/dynamomodel-guide.md
Jonathan Tong's avatar
docs: update Fern docs for main branch (#5706)  
Jonathan Tong committed
51
52
53
54
55
56 
          - page: Service Discovery
            path: ../pages/kubernetes/service-discovery.md
          - page: Webhooks
            path: ../pages/kubernetes/webhooks.md
          - page: Autoscaling
            path: ../pages/kubernetes/autoscaling.md
Jonathan Tong's avatar
docs: migrate existing docs to fern (#5445)  
Jonathan Tong committed
57
58
59
60 
      - section: Observability (K8s)
        contents:
          - page: Metrics
            path: ../pages/kubernetes/observability/metrics.md
Jonathan Tong's avatar
docs: update Fern docs for main branch (#5706)  
Jonathan Tong committed
61
62 
          - page: Operator Metrics
            path: ../pages/kubernetes/observability/operator-metrics.md
Jonathan Tong's avatar
docs: migrate existing docs to fern (#5445)  
Jonathan Tong committed
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85 
          - page: Logging
            path: ../pages/kubernetes/observability/logging.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: Tool Calling
        path: ../pages/agents/tool-calling.md
      - page: Multimodality Support
        path: ../pages/multimodal/index.md
      - page: Finding Best Initial Configs
        path: ../pages/performance/aiconfigurator.md
      - page: Dynamo Benchmarking Guide
        path: ../pages/benchmarks/benchmarking.md
      - page: Tuning Disaggregated Performance
        path: ../pages/performance/tuning.md
      - page: Writing Python Workers in Dynamo
Jonathan Tong's avatar
docs: update Fern docs for main branch (#5706)  
Jonathan Tong committed
86 
        path: ../pages/development/backend-guide.md
Jonathan Tong's avatar
docs: migrate existing docs to fern (#5445)  
Jonathan Tong committed
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130 
      - section: Observability (Local)
        contents:
          - page: Overview
            path: ../pages/observability/README.md
          - 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
        contents:
          - page: Overview
            path: ../pages/fault-tolerance/README.md
          - 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: Glossary
        path: ../pages/reference/glossary.md

  # ==================== Components ====================
  - section: Components
    contents:
      - section: Backends
        contents:
          - page: vLLM
            path: ../pages/backends/vllm/README.md
          - page: SGLang
            path: ../pages/backends/sglang/README.md
          - page: TensorRT-LLM
            path: ../pages/backends/trtllm/README.md
Jonathan Tong's avatar
docs: update Fern docs for main branch (#5706)  
Jonathan Tong committed
131
132
133
134 
      - section: Frontends
        contents:
          - page: KServe
            path: ../pages/frontends/kserve.md
Jonathan Tong's avatar
docs: migrate existing docs to fern (#5445)  
Jonathan Tong committed
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180 
      - page: Router
        path: ../pages/router/README.md
      - section: Planner
        contents:
          - page: Overview
            path: ../pages/planner/planner-intro.md
          - page: SLA Planner Quick Start
            path: ../pages/planner/sla-planner-quickstart.md
          - page: SLA-Driven Profiling
            path: ../pages/benchmarks/sla-driven-profiling.md
          - page: SLA-based Planner
            path: ../pages/planner/sla-planner.md
      - section: KVBM
        contents:
          - page: Overview
            path: ../pages/kvbm/kvbm-intro.md
          - page: Motivation
            path: ../pages/kvbm/kvbm-motivation.md
          - page: Architecture
            path: ../pages/kvbm/kvbm-architecture.md
          - page: Components
            path: ../pages/kvbm/kvbm-components.md
          - page: Design Deep Dive
            path: ../pages/kvbm/kvbm-design-deepdive.md
          - page: Integrations
            path: ../pages/kvbm/kvbm-integrations.md
          - page: KVBM in vLLM
            path: ../pages/kvbm/vllm-setup.md
          - page: KVBM in TRTLLM
            path: ../pages/kvbm/trtllm-setup.md
          - page: LMCache Integration
            path: ../pages/backends/vllm/LMCache-Integration.md
          - page: Further Reading
            path: ../pages/kvbm/kvbm-reading.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
Jonathan Tong's avatar
docs: update Fern docs for main branch (#5706)  
Jonathan Tong committed
181
182 
      - page: Request Plane
        path: ../pages/guides/request-plane.md
Jonathan Tong's avatar
docs: migrate existing docs to fern (#5445)  
Jonathan Tong committed
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310 
      - page: Event Plane
        path: ../pages/design-docs/event-plane.md

  # ==================== Additional Resources ====================
  # Hidden section - these pages are accessible via direct URL but not shown in navigation
  - section: Additional Resources
    hidden: true
    contents:
      - section: Advanced Kubernetes
        contents:
          - page: Create Deployment
            path: ../pages/kubernetes/deployment/create-deployment.md
          - page: Autoscaling
            path: ../pages/kubernetes/autoscaling.md
          - page: Service Discovery
            path: ../pages/kubernetes/service-discovery.md
          - page: Model Caching with Fluid
            path: ../pages/kubernetes/model-caching-with-fluid.md
          - page: FluxCD
            path: ../pages/kubernetes/fluxcd.md
          - page: Webhooks
            path: ../pages/kubernetes/webhooks.md
          - page: API Reference
            path: ../pages/kubernetes/api-reference.md
      - section: Multimodal Details
        contents:
          - page: vLLM
            path: ../pages/multimodal/vllm.md
          - page: SGLang
            path: ../pages/multimodal/sglang.md
          - page: TensorRT-LLM
            path: ../pages/multimodal/trtllm.md
      - section: Router Details
        contents:
          - page: KV Cache Routing
            path: ../pages/router/kv-cache-routing.md
      - section: Benchmarks
        contents:
          - page: KV Router A/B Testing
            path: ../pages/benchmarks/kv-router-ab-testing.md
      - section: Frontends
        contents:
          - page: KServe
            path: ../pages/frontends/kserve.md
      - section: Development
        contents:
          - page: Backend Guide
            path: ../pages/development/backend-guide.md
      - section: Guides
        contents:
          - page: Request Plane
            path: ../pages/guides/request-plane.md
          - page: Jail Stream
            path: ../pages/guides/jail-stream-readme.md
      - page: Load Planner
        path: ../pages/planner/load-planner.md
      - page: CLI Reference
        path: ../pages/reference/cli.md
      - section: API Reference
        contents:
          - section: NIXL Connect
            contents:
              - page: Overview
                path: ../pages/api/nixl-connect/README.md
              - 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
      - section: Backend Details
        contents:
          - section: vLLM
            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: Speculative Decoding
                path: ../pages/backends/vllm/speculative-decoding.md
              - page: Prompt Embeddings
                path: ../pages/backends/vllm/prompt-embeddings.md
              - page: Prometheus
                path: ../pages/backends/vllm/prometheus.md
          - section: SGLang
            contents:
              - page: GPT-OSS
                path: ../pages/backends/sglang/gpt-oss.md
              - page: Disaggregation
                path: ../pages/backends/sglang/sglang-disaggregation.md
              - page: Expert Distribution (EPLB)
                path: ../pages/backends/sglang/expert-distribution-eplb.md
              - page: HiCache Example
                path: ../pages/backends/sglang/sgl-hicache-example.md
              - page: Profiling
                path: ../pages/backends/sglang/profiling.md
              - page: Prometheus
                path: ../pages/backends/sglang/prometheus.md
          - section: TensorRT-LLM
            contents:
              - page: GPT-OSS
                path: ../pages/backends/trtllm/gpt-oss.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: Llama4 + Eagle
                path: ../pages/backends/trtllm/llama4-plus-eagle.md
              - page: Multinode Examples
                path: ../pages/backends/trtllm/multinode/multinode-examples.md
              - page: Prometheus
                path: ../pages/backends/trtllm/prometheus.md