mirror of
https://github.com/NVIDIA/OpenShell.git
synced 2026-10-22 06:19:47 +08:00
Piotr Mlocek
f213e9a49b
* docs(extensibility): reorganize extensibility and middleware guides Add an extensibility overview that introduces the extension protocol and links every extension point, and move extension caller authentication to a shared page used by middleware and gateway interceptors. Split the supervisor middleware guide into an overview, a Configure and Operate guide, and a Middleware Operations reference for service authors. The overview explains when to use middleware, shows where it runs, lists current limitations, and defines the service contract. Configure and Operate covers policy attachment, service registration, failure behavior, and observability. Middleware Operations describes HTTP request, HTTP response, and WebSocket message operations with shared inputs and results, per-operation diagrams, and detail accordions. Pin page slugs so links resolve, redirect the replaced dev middleware URL, and update reference and architecture links. Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com> * docs(middleware): clarify navigation and service contracts Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com> * docs(middleware): drop obsolete dev URL redirect Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com> --------- Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
131 lines
3.7 KiB
YAML
131 lines
3.7 KiB
YAML
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
landing-page:
|
|
page: "Home"
|
|
path: index.mdx
|
|
|
|
navigation:
|
|
- section: "About NVIDIA OpenShell"
|
|
slug: about
|
|
contents:
|
|
- page: "Why OpenShell"
|
|
path: about/overview.mdx
|
|
- page: "Architecture"
|
|
path: about/how-it-works.mdx
|
|
- page: "Installation"
|
|
path: about/installation.mdx
|
|
- page: "Run Your First Agent"
|
|
path: about/run-an-agent.mdx
|
|
- page: "Support Matrix"
|
|
path: reference/support-matrix.mdx
|
|
- section: "How It Works"
|
|
slug: manage
|
|
contents:
|
|
- section: "Gateways"
|
|
slug: gateways
|
|
contents:
|
|
- page: "Overview"
|
|
path: sandboxes/manage-gateways.mdx
|
|
- page: "Authentication"
|
|
path: reference/gateway-auth.mdx
|
|
- page: "Configuration"
|
|
path: reference/gateway-config.mdx
|
|
- page: "Container Deployment"
|
|
path: reference/container-gateway.mdx
|
|
- page: "Workspaces"
|
|
path: sandboxes/manage-workspaces.mdx
|
|
- section: "Sandboxes"
|
|
slug: sandboxes
|
|
contents:
|
|
- page: "Overview"
|
|
path: sandboxes/manage-sandboxes.mdx
|
|
- page: "Runtimes"
|
|
path: reference/sandbox-compute-drivers.mdx
|
|
- section: "Providers"
|
|
slug: providers
|
|
contents:
|
|
- page: "Overview"
|
|
path: sandboxes/manage-providers.mdx
|
|
- page: "Profiles"
|
|
path: providers/profiles.mdx
|
|
- page: "AWS"
|
|
path: providers/aws-sigv4.mdx
|
|
- page: "Google"
|
|
path: providers/google-cloud.mdx
|
|
- section: "Policies"
|
|
slug: policies
|
|
contents:
|
|
- page: "Overview"
|
|
path: sandboxes/policies.mdx
|
|
- page: "Advisor"
|
|
path: sandboxes/policy-advisor.mdx
|
|
- page: "Schema"
|
|
path: reference/policy-schema.mdx
|
|
- page: "Prover"
|
|
path: reference/policy-prover.mdx
|
|
- page: "Default Policy"
|
|
path: reference/default-policy.mdx
|
|
- page: "Inference"
|
|
path: sandboxes/inference-routing.mdx
|
|
- section: "Extensibility"
|
|
slug: extensibility
|
|
contents:
|
|
- page: "Overview"
|
|
path: extensibility/overview.mdx
|
|
- page: "Protocol Negotiation"
|
|
path: extensibility/extension-negotiation.mdx
|
|
- page: "Authentication"
|
|
path: extensibility/extension-authentication.mdx
|
|
- section: "Supervisor Middleware"
|
|
slug: supervisor-middleware
|
|
path: extensibility/supervisor-middleware/index.mdx
|
|
contents:
|
|
- page: "Configuration"
|
|
path: extensibility/supervisor-middleware/configure.mdx
|
|
- page: "Supported Operations"
|
|
path: extensibility/supervisor-middleware/operations.mdx
|
|
- page: "Gateway Interceptors"
|
|
path: extensibility/gateway-interceptors.mdx
|
|
- page: "Drivers"
|
|
path: extensibility/drivers.mdx
|
|
- page: "Isolation Backends"
|
|
path: extensibility/isolation-backends.mdx
|
|
- folder: observability
|
|
title: "Observability"
|
|
- folder: kubernetes
|
|
title: "Kubernetes"
|
|
- section: "Tutorials"
|
|
slug: tutorials
|
|
contents:
|
|
- page: "First Network Policy"
|
|
path: get-started/tutorials/first-network-policy.mdx
|
|
- page: "GitHub Push Access"
|
|
path: get-started/tutorials/github-sandbox.mdx
|
|
- page: "Microsoft Graph Provider Refresh"
|
|
path: get-started/tutorials/microsoft-graph-provider-refresh.mdx
|
|
- section: "SDK Reference"
|
|
slug: sdk
|
|
contents:
|
|
- page: "Go"
|
|
path: sdk/go.mdx
|
|
- page: "Rust"
|
|
path: sdk/rust.mdx
|
|
- page: "Python"
|
|
path: sdk/python.mdx
|
|
- page: "TypeScript"
|
|
path: sdk/typescript.mdx
|
|
- page: "API Errors"
|
|
path: reference/api-errors.mdx
|
|
- page: "Protobuf Time Types"
|
|
path: reference/protobuf-time-types.mdx
|
|
- folder: security
|
|
title: "Security"
|
|
- section: "Upgrade Guides"
|
|
slug: upgrade
|
|
contents:
|
|
- page: "0.1.0"
|
|
path: upgrade/0-1-0.mdx
|
|
- folder: resources
|
|
title: "Resources"
|