diff --git a/README.md b/README.md index cdbe456239..072e83f13b 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,11 @@ [![Security Policy](https://img.shields.io/badge/Security-Report%20a%20Vulnerability-red)](SECURITY.md) [![Documentation](https://img.shields.io/badge/docs-latest-brightgreen)](https://docs.nvidia.com/openshell/latest/index.html) +> [!NOTE] +> 🚧 OpenShell is now part of the CNCF! We’re in the process of moving development to [ai-openshell](https://github.com/ai-openshell) and governance to the CNCF. Until the move is complete, please continue to use the [NVIDIA/OpenShell](https://github.com/NVIDIA/OpenShell) repo for code, issues, and pull requests. + + + > [!IMPORTANT] > **New in OpenShell 0.1.x:** a stable release cadence, new isolation primitives, an expanded extension surface, and new APIs. [Read the 0.1.0 upgrade guide](https://docs.nvidia.com/openshell/latest/upgrade/0-1-0). diff --git a/docs/CONTRIBUTING.mdx b/docs/CONTRIBUTING.mdx index bd3e66350f..155770b5a2 100644 --- a/docs/CONTRIBUTING.mdx +++ b/docs/CONTRIBUTING.mdx @@ -1,10 +1,10 @@ --- # SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. # SPDX-License-Identifier: Apache-2.0 -title: "Contributing to NVIDIA OpenShell Documentation" +title: "Contributing to OpenShell Documentation" description: "" --- -This guide covers how to write, edit, and review documentation for NVIDIA OpenShell. If you change code that affects user-facing behavior, update the relevant docs in the same PR. +This guide covers how to write, edit, and review documentation for OpenShell. If you change code that affects user-facing behavior, update the relevant docs in the same PR. The published docs live in `docs/`, navigation is defined in `docs/index.yml`, and `fern/` contains the site config, components, and theme assets. diff --git a/docs/about/overview.mdx b/docs/about/overview.mdx index 011bb6d55b..d77febbf27 100644 --- a/docs/about/overview.mdx +++ b/docs/about/overview.mdx @@ -1,14 +1,14 @@ --- # SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. # SPDX-License-Identifier: Apache-2.0 -title: "Overview of NVIDIA OpenShell" +title: "Overview of OpenShell" sidebar-title: "Overview" description: "OpenShell is the safe, private runtime for fleets of autonomous AI agents. Run agents in sandboxed environments that protect your data, credentials, and infrastructure." keywords: "Generative AI, Cybersecurity, AI Agents, Sandboxing, Security, Privacy, Provider Credentials" position: 1 --- -NVIDIA OpenShell is an open-source runtime for executing fleets of autonomous AI agents in sandboxed environments with kernel-level isolation. It combines sandbox runtime controls and a declarative YAML policy so teams can run agents without giving them unrestricted access to local files, credentials, and external networks. +OpenShell is an open-source runtime for executing fleets of autonomous AI agents in sandboxed environments with kernel-level isolation. It combines sandbox runtime controls and a declarative YAML policy so teams can run agents without giving them unrestricted access to local files, credentials, and external networks. New in OpenShell 0.1.x: a [stable release cadence](/about/support-matrix#releases), new [isolation primitives](/about/architecture), and an expanded [extension surface](/extensibility/overview), along with much more. diff --git a/docs/index.mdx b/docs/index.mdx index 45f99288a6..5846c828e6 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -1,7 +1,7 @@ --- # SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. # SPDX-License-Identifier: Apache-2.0 -title: "NVIDIA OpenShell Developer Guide" +title: "OpenShell Developer Guide" description: "OpenShell is the safe, private runtime for fleets of autonomous AI agents. Run agents in sandboxed environments that protect your data, credentials, and infrastructure." keywords: "Generative AI, Cybersecurity, AI Agents, Sandboxing, Security, Privacy, Provider Credentials" position: 1 @@ -30,7 +30,7 @@ import { CommandTerminal } from "./_components/CommandTerminal"; ]} /> -NVIDIA OpenShell is the safe, private runtime for fleets of autonomous AI agents. It provides sandboxed execution environments +OpenShell is the safe, private runtime for fleets of autonomous AI agents. It provides sandboxed execution environments that protect your data, credentials, and infrastructure. Agents run with exactly the permissions they need and nothing more, governed by declarative policies that prevent unauthorized file access, data exfiltration, and uncontrolled network activity. diff --git a/docs/index.yml b/docs/index.yml index 596ac87172..9f6b4084eb 100644 --- a/docs/index.yml +++ b/docs/index.yml @@ -6,7 +6,7 @@ landing-page: path: index.mdx navigation: -- section: "About NVIDIA OpenShell" +- section: "About OpenShell" slug: about contents: - page: "Overview" diff --git a/docs/resources/license.mdx b/docs/resources/license.mdx index 56281bea1c..78e5fc7c41 100644 --- a/docs/resources/license.mdx +++ b/docs/resources/license.mdx @@ -2,12 +2,12 @@ # SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. # SPDX-License-Identifier: Apache-2.0 title: "License" -description: "NVIDIA OpenShell is licensed under the Apache License, Version 2.0." +description: "OpenShell is licensed under the Apache License, Version 2.0." keywords: "Legal, License, Apache 2.0" position: 1 --- -NVIDIA OpenShell is licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). +OpenShell is licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). Apache License Version 2.0, January 2004 diff --git a/docs/tutorials/first-network-policy.mdx b/docs/tutorials/first-network-policy.mdx index 5cdeef2200..0fe3dbf104 100644 --- a/docs/tutorials/first-network-policy.mdx +++ b/docs/tutorials/first-network-policy.mdx @@ -23,7 +23,7 @@ After completing this tutorial, you understand: - A user-owned workload image with `curl` installed. -To run every step of this tutorial, you can also use the automated demo script at the [examples/sandbox-policy-quickstart](https://github.com/NVIDIA/OpenShell/blob/main/examples/sandbox-policy-quickstart) directory in the NVIDIA OpenShell repository. It runs the full walkthrough in under a minute but without any user interaction. +To run every step of this tutorial, you can also use the automated demo script at the [examples/sandbox-policy-quickstart](https://github.com/NVIDIA/OpenShell/blob/main/examples/sandbox-policy-quickstart) directory in the OpenShell repository. It runs the full walkthrough in under a minute but without any user interaction. ```shell bash examples/sandbox-policy-quickstart/demo.sh diff --git a/docs/upgrade/0-1-0.mdx b/docs/upgrade/0-1-0.mdx index 2e7ea7a37a..6a787b1639 100644 --- a/docs/upgrade/0-1-0.mdx +++ b/docs/upgrade/0-1-0.mdx @@ -1,7 +1,7 @@ --- # SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. # SPDX-License-Identifier: Apache-2.0 -title: "Upgrade to NVIDIA OpenShell 0.1.0" +title: "Upgrade to OpenShell 0.1.0" sidebar-title: "0.1.0" description: "Prepare OpenShell operators and users for the breaking changes in version 0.1.0." keywords: "Generative AI, Cybersecurity, AI Agents, Sandboxing, Upgrade, Migration" diff --git a/fern/docs.yml b/fern/docs.yml index a36a9ac1e3..c28a70d1cd 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -8,7 +8,7 @@ instances: custom-domain: docs.nvidia.com/openshell multi-source: true -title: NVIDIA OpenShell +title: OpenShell global-theme: nvidia