From b1c3401fff821ba1b18839fd34e7475e51aed6a3 Mon Sep 17 00:00:00 2001 From: mesutoezdil Date: Thu, 16 Jul 2026 21:34:36 +0200 Subject: [PATCH] docs: fix broken links and small inconsistencies - README: fix github-sandbox tutorial link missing get-started segment - README: replace dead community-sandboxes doc link with the actual repo - README: match supported host list to support-matrix.mdx - architecture/README: list the missing google-vertex-ai-provider doc - SECURITY.md: fix a mis-indented list item - standardize on NVIDIA/OpenShell-Community casing for repo links --- README.md | 6 +++--- SECURITY.md | 2 +- architecture/README.md | 1 + docs/reference/default-policy.mdx | 4 ++-- docs/reference/support-matrix.mdx | 4 ++-- 5 files changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 33b2736bc2..7c8dc8da2e 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ OpenShell is built agent-first. The project ships with agent skills for everythi ### Prerequisites -- **A supported host** — macOS, Windows with WSL 2, or Linux. +- **A supported host** — Linux, macOS (Apple Silicon), or Windows with WSL 2 (experimental). - **A local runtime** — Docker, Podman, or host virtualization enabled for MicroVM-backed sandboxes. ### Install @@ -198,7 +198,7 @@ openshell sandbox create --from ./my-sandbox-dir # local Dockerfile openshell sandbox create --from registry.io/img:v1 # container image ``` -See the [community sandboxes](https://docs.nvidia.com/openshell/latest/sandboxes/community-sandboxes) catalog and the [BYOC example](https://github.com/NVIDIA/OpenShell/tree/main/examples/bring-your-own-container) for details. +See the [OpenShell Community](https://github.com/NVIDIA/OpenShell-Community) catalog and the [BYOC example](https://github.com/NVIDIA/OpenShell/tree/main/examples/bring-your-own-container) for details. ## Explore with Your Agent @@ -234,7 +234,7 @@ All implementation work is human-gated — agents propose plans, humans approve, - [Full Documentation](https://docs.nvidia.com/openshell/latest/index.html) — overview, architecture, tutorials, and reference - [Quickstart](https://docs.nvidia.com/openshell/latest/get-started/quickstart) — detailed install and first sandbox walkthrough -- [GitHub Sandbox Tutorial](https://docs.nvidia.com/openshell/latest/tutorials/github-sandbox) — end-to-end scoped GitHub repo access +- [GitHub Sandbox Tutorial](https://docs.nvidia.com/openshell/latest/get-started/tutorials/github-sandbox) — end-to-end scoped GitHub repo access - [Architecture](https://github.com/NVIDIA/OpenShell/tree/main/architecture) — detailed architecture docs and design decisions - [Roadmap](https://github.com/orgs/NVIDIA/projects/233) — planned work and project priorities - [RFC Board](https://github.com/orgs/NVIDIA/projects/233/views/6) — RFC proposals tracked on the OpenShell Roadmap with the `rfc` label diff --git a/SECURITY.md b/SECURITY.md index 9000efe988..76ba2ce72d 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -13,7 +13,7 @@ To report a potential security vulnerability in any NVIDIA product: - We encourage you to use the following PGP key for secure email communication: [NVIDIA public PGP Key for communication](https://www.nvidia.com/en-us/security/pgp-key) - Please include the following information: - Product/Driver name and version/branch that contains the vulnerability - - Type of vulnerability (code execution, denial of service, buffer overflow, etc.) + - Type of vulnerability (code execution, denial of service, buffer overflow, etc.) - Instructions to reproduce the vulnerability - Proof-of-concept or exploit code - Potential impact of the vulnerability, including how an attacker could exploit the vulnerability diff --git a/architecture/README.md b/architecture/README.md index f8961a9387..3fc72afd25 100644 --- a/architecture/README.md +++ b/architecture/README.md @@ -166,6 +166,7 @@ that crate's `README.md`. | [Security Policy](security-policy.md) | Policy model, enforcement layers, policy updates, policy advisor, and security logging. | | [Compute Runtimes](compute-runtimes.md) | Docker, Podman, Kubernetes, VM, sandbox images, and runtime-specific responsibilities. | | [Build](build.md) | Build artifacts, CI/E2E, docs site validation, and release packaging. | +| [Google Vertex AI Provider](google-vertex-ai-provider.md) | Implementation reference for the `google-vertex-ai` provider, from CLI through gateway to sandbox. | ## `rfc/` vs `architecture/` diff --git a/docs/reference/default-policy.mdx b/docs/reference/default-policy.mdx index 73dedf89c5..bd5c01facc 100644 --- a/docs/reference/default-policy.mdx +++ b/docs/reference/default-policy.mdx @@ -7,7 +7,7 @@ description: "Breakdown of the built-in default policy applied when you create a keywords: "Generative AI, Cybersecurity, AI Agents, Sandboxing, Security, Policy" position: 2 --- -The default policy is the policy applied when you create an OpenShell sandbox without `--policy`. It is baked into the community base image ([`ghcr.io/nvidia/openshell-community/sandboxes/base`](https://github.com/nvidia/openshell-community)) and defined in the community repo's `dev-sandbox-policy.yaml`. +The default policy is the policy applied when you create an OpenShell sandbox without `--policy`. It is baked into the community base image ([`ghcr.io/nvidia/openshell-community/sandboxes/base`](https://github.com/NVIDIA/OpenShell-Community)) and defined in the community repo's `dev-sandbox-policy.yaml`. ## Agent Compatibility @@ -26,4 +26,4 @@ If you run a non-Claude agent without a custom policy, the agent's API calls are ## Default Policy Blocks -The default policy blocks are defined in the community base image. Refer to the [openshell-community repository](https://github.com/nvidia/openshell-community) for the full `dev-sandbox-policy.yaml` source. +The default policy blocks are defined in the community base image. Refer to the [OpenShell Community repository](https://github.com/NVIDIA/OpenShell-Community) for the full `dev-sandbox-policy.yaml` source. diff --git a/docs/reference/support-matrix.mdx b/docs/reference/support-matrix.mdx index c75f5338ad..cfa5b69549 100644 --- a/docs/reference/support-matrix.mdx +++ b/docs/reference/support-matrix.mdx @@ -61,7 +61,7 @@ Install the software for the compute driver you use: ## Sandbox Runtime Versions -Sandbox container images are maintained in the [openshell-community](https://github.com/nvidia/openshell-community) repository. Refer to that repository for the current list of installed components and their versions. +Sandbox container images are maintained in the [OpenShell Community](https://github.com/NVIDIA/OpenShell-Community) repository. Refer to that repository for the current list of installed components and their versions. ## Container Images @@ -73,7 +73,7 @@ OpenShell publishes the gateway image for `linux/amd64` and `linux/arm64`. The Helm chart in `deploy/helm/openshell` deploys the gateway workload, service account, service, optional persistent storage, and network policy for Kubernetes. It defaults to a StatefulSet for SQLite-backed installs and can render a Deployment for external database-backed installs. -Sandbox images are maintained separately in the [openshell-community](https://github.com/nvidia/openshell-community) repository. +Sandbox images are maintained separately in the [OpenShell Community](https://github.com/NVIDIA/OpenShell-Community) repository. To override the default image references, use Helm values: