From a281a63132433065315c159f2233d08e092abd09 Mon Sep 17 00:00:00 2001 From: Miyoung Choi Date: Thu, 9 Apr 2026 14:12:32 -0700 Subject: [PATCH 1/2] docs: fix TOC structure --- fern/docs.yml | 9 +++++++++ fern/fern.config.json | 2 +- .../tutorials/first-network-policy.mdx | 2 +- .../{ => get-started}/tutorials/github-sandbox.mdx | 2 +- fern/pages/{ => get-started}/tutorials/index.mdx | 10 +++++----- .../{ => get-started}/tutorials/inference-ollama.mdx | 2 +- .../tutorials/local-inference-lmstudio.mdx | 2 +- fern/versions/latest.yml | 12 +++++++----- 8 files changed, 26 insertions(+), 15 deletions(-) rename fern/pages/{ => get-started}/tutorials/first-network-policy.mdx (99%) rename fern/pages/{ => get-started}/tutorials/github-sandbox.mdx (99%) rename fern/pages/{ => get-started}/tutorials/index.mdx (74%) rename fern/pages/{ => get-started}/tutorials/inference-ollama.mdx (99%) rename fern/pages/{ => get-started}/tutorials/local-inference-lmstudio.mdx (99%) diff --git a/fern/docs.yml b/fern/docs.yml index d1dab6e7..dca58a05 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -84,3 +84,12 @@ redirects: 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*" diff --git a/fern/fern.config.json b/fern/fern.config.json index 3d47d15e..4f613fef 100644 --- a/fern/fern.config.json +++ b/fern/fern.config.json @@ -1,4 +1,4 @@ { "organization": "nvidia", - "version": "4.62.4" + "version": "4.65.1" } diff --git a/fern/pages/tutorials/first-network-policy.mdx b/fern/pages/get-started/tutorials/first-network-policy.mdx similarity index 99% rename from fern/pages/tutorials/first-network-policy.mdx rename to fern/pages/get-started/tutorials/first-network-policy.mdx index 7f8357a2..f0287afc 100644 --- a/fern/pages/tutorials/first-network-policy.mdx +++ b/fern/pages/get-started/tutorials/first-network-policy.mdx @@ -1,7 +1,7 @@ --- title: "Write Your First Sandbox Network Policy" sidebar-title: "First Network Policy" -slug: "tutorials/first-network-policy" +slug: "get-started/tutorials/first-network-policy" description: "See how OpenShell network policies work by creating a sandbox, observing default-deny in action, and applying a fine-grained L7 read-only rule." keywords: "Generative AI, Cybersecurity, Tutorial, Policy, Network Policy, Sandbox, Security" tags: diff --git a/fern/pages/tutorials/github-sandbox.mdx b/fern/pages/get-started/tutorials/github-sandbox.mdx similarity index 99% rename from fern/pages/tutorials/github-sandbox.mdx rename to fern/pages/get-started/tutorials/github-sandbox.mdx index c08bbdfa..c31f84cb 100644 --- a/fern/pages/tutorials/github-sandbox.mdx +++ b/fern/pages/get-started/tutorials/github-sandbox.mdx @@ -1,7 +1,7 @@ --- title: "Grant GitHub Push Access to a Sandboxed Agent" sidebar-title: "GitHub Push Access" -slug: "tutorials/github-sandbox" +slug: "get-started/tutorials/github-sandbox" description: "Learn the iterative policy workflow by launching a sandbox, diagnosing a GitHub access denial, and applying a custom policy to fix it." keywords: "Generative AI, Cybersecurity, Tutorial, GitHub, Sandbox, Policy, Claude Code" tags: diff --git a/fern/pages/tutorials/index.mdx b/fern/pages/get-started/tutorials/index.mdx similarity index 74% rename from fern/pages/tutorials/index.mdx rename to fern/pages/get-started/tutorials/index.mdx index e523f46f..bd13c418 100644 --- a/fern/pages/tutorials/index.mdx +++ b/fern/pages/get-started/tutorials/index.mdx @@ -1,6 +1,6 @@ --- title: "Tutorials" -slug: "tutorials" +slug: "get-started/tutorials" description: "Step-by-step walkthroughs for OpenShell, from first sandbox to production-ready policies." keywords: "Generative AI, Cybersecurity, Tutorial, Sandbox, Policy" tags: @@ -16,22 +16,22 @@ Hands-on walkthroughs that teach OpenShell concepts by building real configurati - + Create a sandbox, observe default-deny networking, apply a read-only L7 policy, and inspect audit logs. No AI agent required. - + Launch Claude Code in a sandbox, diagnose a policy denial, and iterate on a custom GitHub policy from outside the sandbox. - + Route inference through Ollama using cloud-hosted or local models, and verify it from a sandbox. - + Route inference to a local LM Studio server via the OpenAI or Anthropic compatible APIs. diff --git a/fern/pages/tutorials/inference-ollama.mdx b/fern/pages/get-started/tutorials/inference-ollama.mdx similarity index 99% rename from fern/pages/tutorials/inference-ollama.mdx rename to fern/pages/get-started/tutorials/inference-ollama.mdx index 6d83bb4f..879a36e5 100644 --- a/fern/pages/tutorials/inference-ollama.mdx +++ b/fern/pages/get-started/tutorials/inference-ollama.mdx @@ -1,7 +1,7 @@ --- title: "Run Local Inference with Ollama" sidebar-title: "Inference with Ollama" -slug: "tutorials/inference-ollama" +slug: "get-started/tutorials/inference-ollama" description: "Run local and cloud models inside an OpenShell sandbox using the Ollama community sandbox, or route sandbox requests to a host-level Ollama server." keywords: "Generative AI, Cybersecurity, Tutorial, Inference Routing, Ollama, Local Inference, Sandbox" tags: diff --git a/fern/pages/tutorials/local-inference-lmstudio.mdx b/fern/pages/get-started/tutorials/local-inference-lmstudio.mdx similarity index 99% rename from fern/pages/tutorials/local-inference-lmstudio.mdx rename to fern/pages/get-started/tutorials/local-inference-lmstudio.mdx index bea4e8ca..6b85bb15 100644 --- a/fern/pages/tutorials/local-inference-lmstudio.mdx +++ b/fern/pages/get-started/tutorials/local-inference-lmstudio.mdx @@ -1,7 +1,7 @@ --- title: "Route Local Inference Requests to LM Studio" sidebar-title: "Local Inference with LM Studio" -slug: "tutorials/local-inference-lmstudio" +slug: "get-started/tutorials/local-inference-lmstudio" description: "Configure inference.local to route sandbox requests to a local LM Studio server running on the gateway host." keywords: "Generative AI, Cybersecurity, Tutorial, Inference Routing, LM Studio, Local Inference, Sandbox" tags: diff --git a/fern/versions/latest.yml b/fern/versions/latest.yml index b1058b77..20da3400 100644 --- a/fern/versions/latest.yml +++ b/fern/versions/latest.yml @@ -1,17 +1,19 @@ # SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. # SPDX-License-Identifier: Apache-2.0 navigation: +- section: "Documentation" + contents: + - page: "Home" + path: ../pages/index.mdx +- folder: ../pages/about + title: "About NVIDIA OpenShell" - section: "Get Started" slug: get-started contents: - - page: "Home" - path: ../pages/index.mdx - page: "Quickstart" path: ../pages/get-started/quickstart.mdx - - folder: ../pages/tutorials + - folder: ../pages/get-started/tutorials skip-slug: true -- folder: ../pages/about - title: "About NVIDIA OpenShell" - folder: ../pages/sandboxes - folder: ../pages/inference title: "Inference Routing" From 80c43e3d537e34a2ceccd005207c899307033912 Mon Sep 17 00:00:00 2001 From: Miyoung Choi Date: Thu, 9 Apr 2026 16:20:42 -0700 Subject: [PATCH 2/2] docs: fix wrong section title --- docs/index.yml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/index.yml b/docs/index.yml index ccfc413b..40942dd2 100644 --- a/docs/index.yml +++ b/docs/index.yml @@ -2,10 +2,8 @@ # SPDX-License-Identifier: Apache-2.0 navigation: -- section: "Documentation" - contents: - - page: "Home" - path: index.mdx +- page: "Home" + path: index.mdx - folder: about title: "About NVIDIA OpenShell" - section: "Get Started"