Unverified Commit ece08dc9 authored by Neal Vaidya's avatar Neal Vaidya Committed by GitHub
Browse files

docs: restructure docs directory and move fern config to fern/ (#6700)


Signed-off-by: default avatarNeal Vaidya <nealv@nvidia.com>
Co-authored-by: default avatarClaude Opus 4.6 <noreply@anthropic.com>
parent 1412e44b
...@@ -92,7 +92,7 @@ extraPodSpec: ...@@ -92,7 +92,7 @@ extraPodSpec:
Before using these templates, ensure you have: Before using these templates, ensure you have:
1. **Dynamo Kubernetes Platform installed** - See [Quickstart Guide](../../../../docs/pages/kubernetes/README.md) 1. **Dynamo Kubernetes Platform installed** - See [Quickstart Guide](../../../../docs/kubernetes/README.md)
2. **Kubernetes cluster with GPU support** 2. **Kubernetes cluster with GPU support**
3. **Container registry access** for vLLM runtime images 3. **Container registry access** for vLLM runtime images
4. **HuggingFace token secret** (referenced as `envFromSecret: hf-token-secret`) 4. **HuggingFace token secret** (referenced as `envFromSecret: hf-token-secret`)
...@@ -110,7 +110,7 @@ docker build -f container/rendered.Dockerfile . ...@@ -110,7 +110,7 @@ docker build -f container/rendered.Dockerfile .
### Pre-Deployment Profiling (SLA Planner Only) ### Pre-Deployment Profiling (SLA Planner Only)
If using the SLA Planner deployment (`disagg_planner.yaml`), follow the [pre-deployment profiling guide](../../../../docs/pages/components/profiler/profiler-guide.md) to run pre-deployment profiling. If using the SLA Planner deployment (`disagg_planner.yaml`), follow the [pre-deployment profiling guide](../../../../docs/components/profiler/profiler-guide.md) to run pre-deployment profiling.
## Usage ## Usage
...@@ -235,7 +235,7 @@ All templates use **Qwen/Qwen3-0.6B** as the default model, but you can use any ...@@ -235,7 +235,7 @@ All templates use **Qwen/Qwen3-0.6B** as the default model, but you can use any
## Request Migration ## Request Migration
You can enable [request migration](../../../../docs/pages/fault-tolerance/request-migration.md) to handle worker failures gracefully by adding the migration limit argument to worker configurations: You can enable [request migration](../../../../docs/fault-tolerance/request-migration.md) to handle worker failures gracefully by adding the migration limit argument to worker configurations:
```yaml ```yaml
args: args:
...@@ -245,12 +245,12 @@ args: ...@@ -245,12 +245,12 @@ args:
## Further Reading ## Further Reading
- **Deployment Guide**: [Creating Kubernetes Deployments](../../../../docs/pages/kubernetes/deployment/create-deployment.md) - **Deployment Guide**: [Creating Kubernetes Deployments](../../../../docs/kubernetes/deployment/create-deployment.md)
- **Quickstart**: [Deployment Quickstart](../../../../docs/pages/kubernetes/README.md) - **Quickstart**: [Deployment Quickstart](../../../../docs/kubernetes/README.md)
- **Platform Setup**: [Dynamo Kubernetes Platform Installation](../../../../docs/pages/kubernetes/installation-guide.md) - **Platform Setup**: [Dynamo Kubernetes Platform Installation](../../../../docs/kubernetes/installation-guide.md)
- **SLA Planner**: [SLA Planner Quickstart Guide](../../../../docs/pages/components/planner/planner-guide.md) - **SLA Planner**: [SLA Planner Quickstart Guide](../../../../docs/components/planner/planner-guide.md)
- **Examples**: [Deployment Examples](../../../../docs/pages/getting-started/examples.md) - **Examples**: [Deployment Examples](../../../../docs/getting-started/examples.md)
- **Architecture Docs**: [Disaggregated Serving](../../../../docs/pages/design-docs/disagg-serving.md), [KV-Aware Routing](../../../../docs/pages/components/router/README.md) - **Architecture Docs**: [Disaggregated Serving](../../../../docs/design-docs/disagg-serving.md), [KV-Aware Routing](../../../../docs/components/router/README.md)
## Troubleshooting ## Troubleshooting
...@@ -262,4 +262,4 @@ Common issues and solutions: ...@@ -262,4 +262,4 @@ Common issues and solutions:
4. **Out of memory**: Increase memory limits or reduce model batch size 4. **Out of memory**: Increase memory limits or reduce model batch size
5. **Port forwarding issues**: Ensure correct pod UUID in port-forward command 5. **Port forwarding issues**: Ensure correct pod UUID in port-forward command
For additional support, refer to the [deployment troubleshooting guide](../../../../docs/pages/kubernetes/README.md). For additional support, refer to the [deployment troubleshooting guide](../../../../docs/kubernetes/README.md).
...@@ -11,7 +11,7 @@ This deployment pattern enables dynamic LoRA adapter loading from S3-compatible ...@@ -11,7 +11,7 @@ This deployment pattern enables dynamic LoRA adapter loading from S3-compatible
- Kubernetes cluster with GPU support - Kubernetes cluster with GPU support
- Helm 3.x installed - Helm 3.x installed
- `kubectl` configured to access your cluster - `kubectl` configured to access your cluster
- Dynamo Kubernetes Platform installed ([Installation Guide](../../../../../docs/pages/kubernetes/installation-guide.md)) - Dynamo Kubernetes Platform installed ([Installation Guide](../../../../../docs/kubernetes/installation-guide.md))
- HuggingFace token for downloading Base and LoRA adapters - HuggingFace token for downloading Base and LoRA adapters
## Files in This Directory ## Files in This Directory
...@@ -293,5 +293,5 @@ kubectl delete secret hf-token-secret -n ${NAMESPACE} ...@@ -293,5 +293,5 @@ kubectl delete secret hf-token-secret -n ${NAMESPACE}
## Further Reading ## Further Reading
- [vLLM Deployment Guide](../README.md) - Other deployment patterns - [vLLM Deployment Guide](../README.md) - Other deployment patterns
- [Dynamo Kubernetes Guide](../../../../../docs/pages/kubernetes/README.md) - Platform setup - [Dynamo Kubernetes Guide](../../../../../docs/kubernetes/README.md) - Platform setup
- [Installation Guide](../../../../../docs/pages/kubernetes/installation-guide.md) - Platform installation - [Installation Guide](../../../../../docs/kubernetes/installation-guide.md) - Platform installation
...@@ -37,8 +37,8 @@ docker compose -f deploy/docker-compose.yml up -d ...@@ -37,8 +37,8 @@ docker compose -f deploy/docker-compose.yml up -d
## Components ## Components
- [Frontend](/components/src/dynamo/frontend/README.md) - HTTP API endpoint that receives requests and forwards them to the decode worker - [Frontend](/components/src/dynamo/frontend/README.md) - HTTP API endpoint that receives requests and forwards them to the decode worker
- [vLLM Prefill Worker](/docs/pages/backends/vllm/README.md) - Specialized worker for prefill phase execution - [vLLM Prefill Worker](/docs/backends/vllm/README.md) - Specialized worker for prefill phase execution
- [vLLM Decode Worker](/docs/pages/backends/vllm/README.md) - Specialized worker that handles requests and decides between local/remote prefill - [vLLM Decode Worker](/docs/backends/vllm/README.md) - Specialized worker that handles requests and decides between local/remote prefill
```mermaid ```mermaid
--- ---
......
...@@ -4,8 +4,8 @@ This example demonstrates running Dynamo across multiple nodes with **KV-aware r ...@@ -4,8 +4,8 @@ This example demonstrates running Dynamo across multiple nodes with **KV-aware r
For more information about the core concepts, see: For more information about the core concepts, see:
- [Dynamo Disaggregated Serving](../../../docs/pages/design-docs/disagg-serving.md) - [Dynamo Disaggregated Serving](../../../docs/design-docs/disagg-serving.md)
- [KV Cache Routing](../../../docs/pages/components/router/README.md) - [KV Cache Routing](../../../docs/components/router/README.md)
## Architecture Overview ## Architecture Overview
...@@ -65,7 +65,7 @@ This is particularly beneficial for: ...@@ -65,7 +65,7 @@ This is particularly beneficial for:
- **Similar queries**: Common prefixes are computed once and reused - **Similar queries**: Common prefixes are computed once and reused
- **Batch processing**: Related requests can be routed to workers with shared context - **Batch processing**: Related requests can be routed to workers with shared context
For detailed technical information about how KV routing works, see the [Router Guide](../../../docs/pages/components/router/router-guide.md). For detailed technical information about how KV routing works, see the [Router Guide](../../../docs/components/router/router-guide.md).
## Prerequisites ## Prerequisites
...@@ -88,7 +88,7 @@ Install Dynamo with [SGLang](https://docs.sglang.io/) support: ...@@ -88,7 +88,7 @@ Install Dynamo with [SGLang](https://docs.sglang.io/) support:
pip install ai-dynamo[sglang] pip install ai-dynamo[sglang]
``` ```
For more information about the SGLang backend and its integration with Dynamo, see the [SGLang Backend Documentation](../../../docs/pages/backends/sglang/README.md). For more information about the SGLang backend and its integration with Dynamo, see the [SGLang Backend Documentation](../../../docs/backends/sglang/README.md).
### 3. Network Requirements ### 3. Network Requirements
...@@ -475,7 +475,7 @@ python -m dynamo.frontend \ ...@@ -475,7 +475,7 @@ python -m dynamo.frontend \
--router-temperature 0.0 # Temperature for probabilistic routing (0 = deterministic) --router-temperature 0.0 # Temperature for probabilistic routing (0 = deterministic)
``` ```
For more advanced configuration options including custom worker selection, block size tuning, and alternative indexing strategies, see the [Router Guide](../../../docs/pages/components/router/router-guide.md). For more advanced configuration options including custom worker selection, block size tuning, and alternative indexing strategies, see the [Router Guide](../../../docs/components/router/router-guide.md).
## Cleanup ## Cleanup
......
...@@ -17,4 +17,4 @@ limitations under the License. ...@@ -17,4 +17,4 @@ limitations under the License.
# Example: Multi-node TRTLLM Workers with Dynamo on Slurm # Example: Multi-node TRTLLM Workers with Dynamo on Slurm
See [here](/docs/pages/backends/trtllm/multinode) for how to setup this example. See [here](/docs/backends/trtllm/multinode) for how to setup this example.
...@@ -32,7 +32,7 @@ if [[ -z ${IMAGE} ]]; then ...@@ -32,7 +32,7 @@ if [[ -z ${IMAGE} ]]; then
echo "ERROR: You need to set the IMAGE environment variable to the " \ echo "ERROR: You need to set the IMAGE environment variable to the " \
"Dynamo+TRTLLM docker image or .sqsh file from 'enroot import' " \ "Dynamo+TRTLLM docker image or .sqsh file from 'enroot import' " \
"See how to build one from source here: " \ "See how to build one from source here: " \
"https://github.com/ai-dynamo/dynamo/tree/main/docs/pages/backends/trtllm/README.md#build-container" "https://github.com/ai-dynamo/dynamo/tree/main/docs/backends/trtllm/README.md#build-container"
exit 1 exit 1
fi fi
......
...@@ -35,7 +35,7 @@ if [[ -z ${IMAGE} ]]; then ...@@ -35,7 +35,7 @@ if [[ -z ${IMAGE} ]]; then
echo "ERROR: You need to set the IMAGE environment variable to the " \ echo "ERROR: You need to set the IMAGE environment variable to the " \
"Dynamo+TRTLLM docker image or .sqsh file from 'enroot import' " \ "Dynamo+TRTLLM docker image or .sqsh file from 'enroot import' " \
"See how to build one from source here: " \ "See how to build one from source here: " \
"https://github.com/ai-dynamo/dynamo/tree/main/docs/pages/backends/trtllm/README.md#build-container" "https://github.com/ai-dynamo/dynamo/tree/main/docs/backends/trtllm/README.md#build-container"
exit 1 exit 1
fi fi
......
...@@ -18,7 +18,7 @@ docker compose -f deploy/docker-compose.yml up -d ...@@ -18,7 +18,7 @@ docker compose -f deploy/docker-compose.yml up -d
## Components ## Components
- [Frontend](/components/src/dynamo/frontend/README.md) - A built-in component that launches an OpenAI compliant HTTP server, a pre-processor, and a router in a single process - [Frontend](/components/src/dynamo/frontend/README.md) - A built-in component that launches an OpenAI compliant HTTP server, a pre-processor, and a router in a single process
- [vLLM Backend](/docs/pages/backends/vllm/README.md) - A built-in component that runs vLLM within the Dynamo runtime - [vLLM Backend](/docs/backends/vllm/README.md) - A built-in component that runs vLLM within the Dynamo runtime
```mermaid ```mermaid
--- ---
......
...@@ -88,4 +88,4 @@ python3 client.py --middle ...@@ -88,4 +88,4 @@ python3 client.py --middle
- Both modes demonstrate the same cancellation behavior - Both modes demonstrate the same cancellation behavior
- The middle server shows how to properly forward context in proxy scenarios - The middle server shows how to properly forward context in proxy scenarios
For more details on the request cancellation architecture, refer to the [architecture documentation](../../../docs/pages/fault-tolerance/request-cancellation.md). For more details on the request cancellation architecture, refer to the [architecture documentation](../../../docs/fault-tolerance/request-cancellation.md).
...@@ -97,7 +97,7 @@ Hello star! ...@@ -97,7 +97,7 @@ Hello star!
Note that this a very simple degenerate example which does not demonstrate the standard Dynamo FrontEnd-Backend deployment. The hello-world client is not a web server, it is a one-off function which sends the predefined text "world,sun,moon,star" to the backend. The example is meant to show the HelloWorldWorker. As such you will only see the HelloWorldWorker pod in deployment. The client will run and exit and the pod will not be operational. Note that this a very simple degenerate example which does not demonstrate the standard Dynamo FrontEnd-Backend deployment. The hello-world client is not a web server, it is a one-off function which sends the predefined text "world,sun,moon,star" to the backend. The example is meant to show the HelloWorldWorker. As such you will only see the HelloWorldWorker pod in deployment. The client will run and exit and the pod will not be operational.
Follow the [Quickstart Guide](/docs/pages/kubernetes/README.md) to install Dynamo Kubernetes Platform. Follow the [Quickstart Guide](/docs/kubernetes/README.md) to install Dynamo Kubernetes Platform.
Then deploy to kubernetes using Then deploy to kubernetes using
```bash ```bash
......
...@@ -39,7 +39,7 @@ gpu-operator nvidia-driver-daemonset-xxxxx 1/1 ...@@ -39,7 +39,7 @@ gpu-operator nvidia-driver-daemonset-xxxxx 1/1
## Step 3: Deploy Dynamo Kubernetes Operator ## Step 3: Deploy Dynamo Kubernetes Operator
Follow the [Deploying Inference Graphs to Kubernetes](../../../docs/pages/kubernetes/README.md) guide to install Dynamo on your AKS cluster. Follow the [Deploying Inference Graphs to Kubernetes](../../../docs/kubernetes/README.md) guide to install Dynamo on your AKS cluster.
Validate that the Dynamo pods are running: Validate that the Dynamo pods are running:
...@@ -56,7 +56,7 @@ kubectl get pods -n dynamo-system ...@@ -56,7 +56,7 @@ kubectl get pods -n dynamo-system
## Step 4: Deploy and Test a Model ## Step 4: Deploy and Test a Model
Follow the [Deploy Model/Workflow](../../../docs/pages/kubernetes/installation-guide.md#next-steps) guide to deploy and test a model on your AKS cluster. Follow the [Deploy Model/Workflow](../../../docs/kubernetes/installation-guide.md#next-steps) guide to deploy and test a model on your AKS cluster.
## AKS Storage options for Model Caching and Runtime Data ## AKS Storage options for Model Caching and Runtime Data
......
...@@ -71,7 +71,7 @@ kubectl create secret generic hf-token-secret \ ...@@ -71,7 +71,7 @@ kubectl create secret generic hf-token-secret \
## Install Dynamo Kubernetes Platform ## Install Dynamo Kubernetes Platform
[See installation steps](/docs/pages/kubernetes/installation-guide.md#overview) [See installation steps](/docs/kubernetes/installation-guide.md#overview)
After installation, verify the installation: After installation, verify the installation:
......
...@@ -11,7 +11,7 @@ This deployment pattern enables dynamic LoRA adapter loading from S3-compatible ...@@ -11,7 +11,7 @@ This deployment pattern enables dynamic LoRA adapter loading from S3-compatible
- Kubernetes cluster with GPU support - Kubernetes cluster with GPU support
- Helm 3.x installed - Helm 3.x installed
- `kubectl` configured to access your cluster - `kubectl` configured to access your cluster
- Dynamo Kubernetes Platform installed ([Installation Guide](../../../../docs/pages/kubernetes/installation-guide.md)) - Dynamo Kubernetes Platform installed ([Installation Guide](../../../../docs/kubernetes/installation-guide.md))
- HuggingFace token for downloading base and LoRA adapters - HuggingFace token for downloading base and LoRA adapters
## Files in This Directory ## Files in This Directory
...@@ -366,5 +366,5 @@ kubectl delete secret hf-token-secret -n ${NAMESPACE} ...@@ -366,5 +366,5 @@ kubectl delete secret hf-token-secret -n ${NAMESPACE}
- [Multimodal LoRA Launch Guide](../../launch/lora/README.md) - Local launch with shell scripts - [Multimodal LoRA Launch Guide](../../launch/lora/README.md) - Local launch with shell scripts
- [LLM LoRA Deployment](../../../backends/vllm/deploy/lora/README.md) - Text-only LoRA deployment pattern - [LLM LoRA Deployment](../../../backends/vllm/deploy/lora/README.md) - Text-only LoRA deployment pattern
- [Dynamo Kubernetes Guide](../../../../docs/pages/kubernetes/README.md) - Platform setup - [Dynamo Kubernetes Guide](../../../../docs/kubernetes/README.md) - Platform setup
- [Installation Guide](../../../../docs/pages/kubernetes/installation-guide.md) - Platform installation - [Installation Guide](../../../../docs/kubernetes/installation-guide.md) - Platform installation
<!-- ---
SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. # SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
--> ---
# Profiler Guide # Profiler Guide
...@@ -579,5 +579,5 @@ kubectl create secret docker-registry nvcr-imagepullsecret \ ...@@ -579,5 +579,5 @@ kubectl create secret docker-registry nvcr-imagepullsecret \
## See Also ## See Also
- [DGDR Examples](../../../components/src/dynamo/profiler/deploy/) - Complete DGDR YAML examples - [DGDR Examples](../../../components/src/dynamo/profiler/deploy/) - Complete DGDR YAML examples
- [DGDR API Reference](/docs/kubernetes/api_reference.md) - DGDR specification - [DGDR API Reference](/docs/kubernetes/api-reference.md) - DGDR specification
- [Profiler Arguments Reference](https://github.com/ai-dynamo/dynamo/blob/main/components/src/dynamo/profiler/utils/dgdr_v1beta1_types.py) - Full Configuration Reference - [Profiler Arguments Reference](https://github.com/ai-dynamo/dynamo/blob/main/components/src/dynamo/profiler/utils/dgdr_v1beta1_types.py) - Full Configuration Reference
...@@ -24,10 +24,10 @@ title: NVIDIA Dynamo Documentation ...@@ -24,10 +24,10 @@ title: NVIDIA Dynamo Documentation
products: products:
- display-name: Dynamo - display-name: Dynamo
slug: / slug: /
path: ./versions/dev.yml path: ../docs/index.yml
versions: versions:
- display-name: dev - display-name: dev
path: ./versions/dev.yml path: ../docs/index.yml
redirects: redirects:
- source: "/dynamo/index.html" - source: "/dynamo/index.html"
...@@ -72,26 +72,26 @@ typography: ...@@ -72,26 +72,26 @@ typography:
bodyFont: bodyFont:
name: NVIDIA name: NVIDIA
paths: paths:
- path: ./assets/fonts/NVIDIASans.woff2 - path: ../docs/assets/fonts/NVIDIASans.woff2
style: normal style: normal
- path: ./assets/fonts/NVIDIASans_Italic.woff2 - path: ../docs/assets/fonts/NVIDIASans_Italic.woff2
style: italic style: italic
codeFont: codeFont:
name: RobotoMono name: RobotoMono
paths: paths:
- path: ./assets/fonts/RobotoMono.woff2 - path: ../docs/assets/fonts/RobotoMono.woff2
theme: theme:
page-actions: toolbar page-actions: toolbar
footer-nav: minimal footer-nav: minimal
logo: logo:
dark: ./assets/NVIDIA_dark.svg dark: ../docs/assets/NVIDIA_dark.svg
light: ./assets/NVIDIA_light.svg light: ../docs/assets/NVIDIA_light.svg
height: 20 height: 20
href: / href: /
right-text: Documentation right-text: Documentation
favicon: ./assets/NVIDIA_symbol.svg favicon: ../docs/assets/NVIDIA_symbol.svg
js: js:
- url: https://assets.adobedtm.com/5d4962a43b79/c1061d2c5e7b/launch-191c2462b890.min.js - url: https://assets.adobedtm.com/5d4962a43b79/c1061d2c5e7b/launch-191c2462b890.min.js
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment