Files
OpenShell/fern/docs.yml
2026-09-18 05:05:14 +00:00

97 lines
3.5 KiB
YAML

# 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
availability: beta
announcement:
message: '<span style="display: block; padding: 0.375rem 0; text-align: left;"><strong>OpenShell 0.1.0 is coming soon.</strong> <a href="https://github.com/NVIDIA/OpenShell/milestone/10" target="_blank" rel="noreferrer">Track progress in the 0.1.0 milestone</a>, <a href="https://docs.nvidia.com/openshell/dev/index.html" target="_blank" rel="noreferrer">read the prerelease documentation</a>, or <a href="https://docs.nvidia.com/openshell/dev/about/installation#install-a-prerelease" target="_blank" rel="noreferrer">install a prerelease</a>.</span>'
redirects:
- source: "/openshell/latest/sandboxes/providers-v2"
destination: "/openshell/latest/providers/profiles"
# 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*"
# tutorials moved under get-started
- source: "/openshell/tutorials"
destination: "/openshell/latest/get-started/tutorials"
- source: "/openshell/tutorials/:path*"
destination: "/openshell/latest/get-started/tutorials/:path*"
- source: "/openshell/latest/tutorials"
destination: "/openshell/latest/get-started/tutorials"
- source: "/openshell/latest/tutorials/:path*"
destination: "/openshell/latest/get-started/tutorials/:path*"