docs.yml

# 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.

# yaml-language-server: $schema=https://schema.buildwithfern.dev/docs-yml.json

instances:
  - url: dynamo.docs.buildwithfern.com/dynamo
    custom-domain: [docs.nvidia.com/dynamo, docs.dynamo.nvidia.com]

title: NVIDIA Dynamo Documentation

agents:
  page-directive: "For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.nvidia.com/dynamo/llms.txt. For full content including API reference and SDK examples, see https://docs.nvidia.com/dynamo/llms-full.txt."


products:
  - display-name: Dynamo
    slug: /
    path: ../docs/index.yml
    versions:
      - display-name: dev
        path: ../docs/index.yml

redirects:
  - source: "/dynamo/index.html"
    destination: "/dynamo/"
  - source: "/dynamo/dev/index.html"
    destination: "/dynamo/dev/"
  - source: "/dynamo/latest/index.html"
    destination: "/dynamo/"
  # Unversioned root redirects → dev (fixes broken links from docs.nvidia.com/dynamo)
  # See: https://github.com/ai-dynamo/dynamo/issues/7297
  - source: "/dynamo/resources/support-matrix"
    destination: "/dynamo/dev/resources/support-matrix"
  - source: "/dynamo/resources/feature-matrix"
    destination: "/dynamo/dev/resources/feature-matrix"
  - source: "/dynamo/resources/release-artifacts"
    destination: "/dynamo/dev/resources/release-artifacts"
  - source: "/dynamo/resources/examples"
    destination: "/dynamo/dev/resources/examples"
  # Version-scoped getting-started → resources redirects
  # Only for versions where these pages moved (dev, v1.0.0, v1.0.1, latest).
  # Older versions (v0.9.x and below) still have pages under getting-started.
  - source: "/dynamo/dev/getting-started/support-matrix"
    destination: "/dynamo/dev/resources/support-matrix"
  - source: "/dynamo/dev/getting-started/feature-matrix"
    destination: "/dynamo/dev/resources/feature-matrix"
  - source: "/dynamo/dev/getting-started/release-artifacts"
    destination: "/dynamo/dev/resources/release-artifacts"
  - source: "/dynamo/dev/getting-started/examples"
    destination: "/dynamo/dev/resources/examples"
  - source: "/dynamo/v1.0.1/getting-started/support-matrix"
    destination: "/dynamo/v1.0.1/resources/support-matrix"
  - source: "/dynamo/v1.0.1/getting-started/feature-matrix"
    destination: "/dynamo/v1.0.1/resources/feature-matrix"
  - source: "/dynamo/v1.0.1/getting-started/release-artifacts"
    destination: "/dynamo/v1.0.1/resources/release-artifacts"
  - source: "/dynamo/v1.0.1/getting-started/examples"
    destination: "/dynamo/v1.0.1/resources/examples"
  - source: "/dynamo/v1.0.0/getting-started/support-matrix"
    destination: "/dynamo/v1.0.0/resources/support-matrix"
  - source: "/dynamo/v1.0.0/getting-started/feature-matrix"
    destination: "/dynamo/v1.0.0/resources/feature-matrix"
  - source: "/dynamo/v1.0.0/getting-started/release-artifacts"
    destination: "/dynamo/v1.0.0/resources/release-artifacts"
  - source: "/dynamo/v1.0.0/getting-started/examples"
    destination: "/dynamo/v1.0.0/resources/examples"
  - source: "/dynamo/latest/getting-started/support-matrix"
    destination: "/dynamo/latest/resources/support-matrix"
  - source: "/dynamo/latest/getting-started/feature-matrix"
    destination: "/dynamo/latest/resources/feature-matrix"
  - source: "/dynamo/latest/getting-started/release-artifacts"
    destination: "/dynamo/latest/resources/release-artifacts"
  - source: "/dynamo/latest/getting-started/examples"
    destination: "/dynamo/latest/resources/examples"
  - source: "/dynamo/dev/user-guides/multimodal-model-serving/diffusion-experimental/:slug*"
    destination: "/dynamo/dev/user-guides/diffusion/:slug*"
  - source: "/dynamo/dev/user-guides/multimodal-model-serving/diffusion-experimental"
    destination: "/dynamo/dev/user-guides/diffusion"
  - source: "/dynamo/dev/user-guides/multimodal-model-serving/vision-language-models-vlms/:slug*"
    destination: "/dynamo/dev/user-guides/multimodal/:slug*"
  - source: "/dynamo/dev/user-guides/multimodal-model-serving/vision-language-models-vlms"
    destination: "/dynamo/dev/user-guides/multimodal"
  - source: "/dynamo/dev/user-guides/diffusion/diffusion-guide"
    destination: "/dynamo/dev/user-guides/diffusion/fastvideo"
  - source: "/dynamo/dev/user-guides/agentic-workloads/:slug*"
    destination: "/dynamo/dev/user-guides/agents/:slug*"
  - source: "/dynamo/dev/user-guides/agentic-workloads"
    destination: "/dynamo/dev/user-guides/agents"
  - source: "/dynamo/latest/planner/planner_intro.html"
    destination: "/dynamo/components/planner"
  # SGLang HiCache moved from Integrations section to Backends > SGLang section
  - source: "/dynamo/dev/integrations/sglang-hicache"
    destination: "/dynamo/dev/backends/sglang/hicache"
  - source: "/dynamo/integrations/sglang-hicache"
    destination: "/dynamo/dev/backends/sglang/hicache"

# GitHub repository link in navbar
navbar-links:
  - type: dropdown
    text: Blog
    links:
      - text: All Posts
        href: /dynamo/dev/blog
      - text: "Full-Stack Optimizations for Agentic Inference"
        href: /dynamo/dev/blog/agentic-inference
      - text: "Flash Indexer: Inter-Galactic KV Routing"
        href: /dynamo/dev/blog/flash-indexer
  - type: github
    value: https://github.com/ai-dynamo/dynamo

footer: ./components/CustomFooter.tsx

layout:
  searchbar-placement: header
  page-width: 1376px
  sidebar-width: 248px
  content-width: 812px
  tabs-placement: header
  hide-feedback: true

metadata:
  canonical-host: "docs.nvidia.com/dynamo"

experimental:
  mdx-components:
    - ./components
  basepath-aware: true

colors:
  accentPrimary:
    dark: '#76B900'
    light: '#76B900'
  background:
    light: '#FFFFFF'
    dark: '#000000'
typography:
  bodyFont:
    name: NVIDIA
    paths:
      - path: ../docs/assets/fonts/NVIDIASans.woff2
        style: normal
      - path: ../docs/assets/fonts/NVIDIASans_Italic.woff2
        style: italic
  codeFont:
    name: RobotoMono
    paths:
      - path: ../docs/assets/fonts/RobotoMono.woff2
theme:
  page-actions: toolbar
  footer-nav: minimal

logo:
  dark: ../docs/assets/NVIDIA_dark.svg
  light: ../docs/assets/NVIDIA_light.svg
  height: 20
  href: /dynamo/getting-started
  right-text: Documentation

favicon: ../docs/assets/NVIDIA_symbol.svg

js:
  - url: https://assets.adobedtm.com/5d4962a43b79/c1061d2c5e7b/launch-191c2462b890.min.js
    strategy: beforeInteractive
css:
  - ./main.css