Skip to content

docs: simplify quickstart install, reorder sections, and clean up sandbox docs#330

Merged
drew merged 1 commit intomainfrom
docs-update-quickstart-and-sandboxes/anewberry
Mar 16, 2026
Merged

docs: simplify quickstart install, reorder sections, and clean up sandbox docs#330
drew merged 1 commit intomainfrom
docs-update-quickstart-and-sandboxes/anewberry

Conversation

@drew
Copy link
Collaborator

@drew drew commented Mar 16, 2026

Summary

  • Rewrites quickstart install to use curl | sh one-liner as primary method, with uv tool install -U openshell as alternative; removes Python/uv from prerequisites
  • Moves "Deploy a Gateway (Optional)" below "Create Your First OpenShell Sandbox" in quickstart
  • Clarifies cloud gateways are for individual users behind a cloud VM, not shared team access
  • Removes: advanced gateway start options, outlook provider type, simulation community sandbox, fully specified sandbox create example with flags table, and sandbox delete --all example

Changes

File Change
docs/get-started/quickstart.md New install section (curl + uv), stripped prerequisites, reordered gateway/sandbox sections
docs/sandboxes/index.md Updated Cloud gateway description
docs/sandboxes/manage-sandboxes.md Removed fully specified create example, flags table, and --all delete
docs/sandboxes/manage-gateways.md Removed Advanced Start Options section
docs/sandboxes/manage-providers.md Removed outlook from provider types table
docs/sandboxes/community-sandboxes.md Removed simulation from catalog table

…dbox docs

Rewrite the quickstart install section to use the one-liner install script
as the primary method with uv tool install as an alternative. Move the
Deploy a Gateway section below Create Your First Sandbox. Clarify that
cloud gateways are for individual users, not team access. Remove advanced
start options from gateways, outlook provider type, simulation community
sandbox, fully specified sandbox create example and flags table, and the
delete --all example.
@drew drew self-assigned this Mar 16, 2026
@github-actions
Copy link

github-actions bot commented Mar 16, 2026

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-03-16 01:12 UTC

@miyoungc miyoungc added the area:docs Documentation and examples label Mar 16, 2026
@drew drew merged commit 808f4ae into main Mar 16, 2026
13 checks passed
@drew drew deleted the docs-update-quickstart-and-sandboxes/anewberry branch March 16, 2026 01:12
drew added a commit that referenced this pull request Mar 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docs Documentation and examples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants