# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
# Fern site config — merged with skills/convert-to-fern/assets/theme/nvidia/docs-theme.yml pattern
# Production: https://docs.nvidia.com/openshell/ — preview + custom-domain share path prefix `openshell`.
# Source checkouts and pull request previews expose the current documentation at /dev.
instances:
  - url: openshell.docs.buildwithfern.com/openshell
    custom-domain: docs.nvidia.com/openshell
    multi-source: true

title: NVIDIA OpenShell

global-theme: nvidia

footer: ./components/CustomFooter.tsx

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

colors:
  accentPrimary:
    dark: "#76B900"
    light: "#76B900"
  background:
    light: "#FFFFFF"
    dark: "#000000"

theme:
  page-actions: toolbar
  footer-nav: minimal

logo:
  dark: ./assets/NVIDIA_dark.svg
  light: ./assets/NVIDIA_light.svg
  height: 20
  href: /openshell
  right-text: OpenShell

favicon: ./assets/NVIDIA_symbol.svg

css:
  - ./main.css

navbar-links:
  - type: github
    value: https://github.com/NVIDIA/OpenShell

experimental:
  mdx-components:
    - ../docs/_components
    - ./components

versions:
  - display-name: Dev
    path: ../docs/index.yml
    slug: dev
    announcement:
      message: '<span style="display: block; padding: 0.375rem 0; text-align: left;"><strong>New in OpenShell 0.1.x:</strong> a stable release cadence, new isolation primitives, an expanded extension surface, and new APIs. <a href="https://docs.nvidia.com/openshell/dev/upgrade/0-1-0" target="_blank" rel="noreferrer">Read the 0.1.0 upgrade guide</a>.</span>'

redirects:
  - source: "/openshell/latest/kubernetes/sandbox-runtime"
    destination: "/openshell/latest/kubernetes/setup"
  - source: "/openshell/dev/kubernetes/sandbox-runtime"
    destination: "/openshell/dev/kubernetes/setup"
  - source: "/openshell/latest/about/how-it-works"
    destination: "/openshell/latest/about/architecture"
  - source: "/openshell/dev/about/how-it-works"
    destination: "/openshell/dev/about/architecture"
  - source: "/openshell/latest/extensibility/extension-negotiation"
    destination: "/openshell/latest/extensibility/overview#protocol-negotiation"
  - source: "/openshell/dev/extensibility/extension-negotiation"
    destination: "/openshell/dev/extensibility/overview#protocol-negotiation"
  - source: "/openshell/latest/providers/google-vertex-ai"
    destination: "/openshell/latest/how-it-works/providers/google#vertex-ai"
  - source: "/openshell/dev/providers/google-vertex-ai"
    destination: "/openshell/dev/how-it-works/providers/google#vertex-ai"
  - source: "/openshell/latest/about/supported-agents"
    destination: "/openshell/latest/about/run-your-first-agent"
  - source: "/openshell/dev/about/supported-agents"
    destination: "/openshell/dev/about/run-your-first-agent"
  - source: "/openshell/latest/get-started/quickstart"
    destination: "/openshell/latest/about/run-your-first-agent"
  - source: "/openshell/dev/get-started/quickstart"
    destination: "/openshell/dev/about/run-your-first-agent"
  - source: "/openshell/latest/sandboxes/providers-v2"
    destination: "/openshell/latest/how-it-works/providers/profiles"
  # Preserve published URLs when page names and slugs change.
  - source: "/openshell/about/why-open-shell"
    destination: "/openshell/latest/about/overview"
  - source: "/openshell/sdk/type-script"
    destination: "/openshell/latest/sdk/typescript"
  - source: "/openshell/latest/about/why-open-shell"
    destination: "/openshell/latest/about/overview"
  - source: "/openshell/dev/about/why-open-shell"
    destination: "/openshell/dev/about/overview"
  - source: "/openshell/latest/sdk/type-script"
    destination: "/openshell/latest/sdk/typescript"
  - source: "/openshell/dev/sdk/type-script"
    destination: "/openshell/dev/sdk/typescript"
  # Paths are relative to the site root; subpath prefix matches instances + custom-domain.
  # Legacy HTML URLs used .../path/to/page/index.html; Fern canonical URLs omit index.html.
  # List explicit /index.html routes before :path*/index.html so empty path segments do not
  # mis-resolve (see NeMo-Curator fern/docs.yml). :path*.html must follow :path*/index.html rules.
  # https://www.buildwithfern.com/learn/docs/configuration/site-level-settings#redirects-configuration
  - source: "/openshell/index.html"
    destination: "/openshell/latest"
  - source: "/openshell/index"
    destination: "/openshell/latest"
  - source: "/openshell/latest/index.html"
    destination: "/openshell/latest"
  - source: "/openshell/latest/index"
    destination: "/openshell/latest"
  - source: "/openshell/latest/:path*/index.html"
    destination: "/openshell/latest/:path*"
  - source: "/openshell/:path*/index.html"
    destination: "/openshell/:path*"
  - source: "/openshell/:path*.html"
    destination: "/openshell/:path*"
  - source: "/openshell/tutorials"
    destination: "/openshell/latest/tutorials"
  - source: "/openshell/tutorials/:path*"
    destination: "/openshell/latest/tutorials/:path*"