Skip to content

docs: consolidate documentation structure#1231

Open
drew wants to merge 5 commits intomainfrom
update-docs
Open

docs: consolidate documentation structure#1231
drew wants to merge 5 commits intomainfrom
update-docs

Conversation

@drew
Copy link
Copy Markdown
Collaborator

@drew drew commented May 7, 2026

Summary

Consolidates the docs navigation and merges overlapping overview pages into fewer, clearer documentation surfaces.

Related Issue

None.

Changes

  • Merge gateway and sandbox overview content into the main Sandboxes and Gateways pages.
  • Move Inference Routing under How It Works and collapse the separate inference pages into a single page.
  • Move Architecture into a dedicated How OpenShell Works page under About, with a shorter Mermaid-based architecture section.
  • Document local machine and remote Kubernetes deployment models on the How OpenShell Works page.
  • Document supervisor protection layers for process, filesystem, network, credentials, inference, and observability boundaries.
  • Update Gateway Authentication with OIDC support and generic mTLS environment-variable setup.
  • Rename Get OpenShell to Installation and update internal links.
  • Remove standalone About Gateways and Sandboxes, Community Sandboxes, Architecture, and inference section pages.
  • Update navigation, homepage cards, and cross-links to the new page locations.

Testing

  • mise run docs:build:strict passes
  • mise run markdown:lint passes
  • mise run pre-commit passes
  • Unit tests added/updated
  • E2E tests added/updated (if applicable)

Checklist

  • Follows Conventional Commits
  • Commits are signed off (DCO)
  • Architecture docs updated (if applicable)

Signed-off-by: Drew Newberry <anewberry@nvidia.com>
@drew drew requested review from a team, derekwaynecarr, maxamillion and mrunalp as code owners May 7, 2026 06:37
drew added 2 commits May 6, 2026 23:47
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 7, 2026

drew added 2 commits May 7, 2026 00:02
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
@drew drew requested a review from miyoungc May 7, 2026 07:36
@@ -40,7 +40,7 @@ The gateway can manage sandboxes on several compute platforms.
| Docker | Supported for local development and single-machine gateways. | Requires Docker Desktop or Docker Engine on the gateway host. |
| Podman | Supported for rootless local and workstation workflows. | Requires a Podman-compatible socket and rootless networking setup. |
| Kubernetes | Supported through the Helm chart in `deploy/helm/openshell`. | Requires a Kubernetes cluster supplied by the operator. |
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this link to the helm chart readme?

@drew drew self-assigned this May 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants