docs(sandboxes): stub SSH editor and app integrations section#25557
Draft
dvdksn wants to merge 15 commits into
Draft
docs(sandboxes): stub SSH editor and app integrations section#25557dvdksn wants to merge 15 commits into
dvdksn wants to merge 15 commits into
Conversation
Add an experimental "Integrations" section documenting how to connect external editors and apps to a sandbox over SSH. Includes an overview page covering the SSH access model, enablement, and setup, plus thin per-tool pages for VS Code, Cursor, Claude Desktop, and Codex. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Bare `sbx daemon start` runs in the foreground and blocks the terminal. Drop it in favor of `sbx daemon stop` plus background auto-start on the next command, and note `sbx daemon start -d` as the explicit alternative. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
SSH integrations require an existing named sandbox, and wildcard SSH configuration does not enumerate sandbox hosts in application pickers. Document manual host entry, the Codex template requirement, the VS Code macOS workaround, loopback forwarding behavior, and the v0.36.0 minimum version.
The loopback forwarding constraint was too opaque in the integration overview and editor pages. Move it to troubleshooting with a concrete local-forward example and explain when the unsupported destination case applies.
The troubleshooting entry described SSH itself as forwarding a service, which obscured the user's action. Describe port forwarding as a capability of the user's SSH connection and state its destination boundary directly.
Manual SSH port forwarding duplicates the sbx ports workflow and exposes an integration implementation detail without a useful user action. Remove the troubleshooting entry and keep service publishing documented through sbx ports.
The draft repeated a stale Claude Desktop SSH label and left screenshot placeholders for a changing external UI. Link to Anthropic's SSH session instructions and retain only the Docker-specific sandbox hostname and SSH config guidance.
The VS Code and Cursor pages duplicated vendor UI instructions and retained screenshot placeholders, while the Codex page named settings not covered by its official guide. Link to maintained vendor instructions where available, verify terminal access first, and keep only Docker-specific manual hostname guidance.
The integration pages depended too heavily on upstream instructions for the basic connection flow. Add the minimum product navigation and sandbox-specific values locally while retaining official guides for additional options.
The desktop client is named ChatGPT, while Codex is the agent that runs against the remote project. Rename the integration page and update its wording while preserving Codex references for the template, CLI, and remote command.
The overview mixed the basic SSH workflow with custom-user, SFTP, and access-revocation details. Focus the page on connecting to a named sandbox and direct file-copy needs to the existing sbx cp documentation.
The sbx cp cross-reference was unrelated to configuring or using SSH integrations. Remove it so the connection section covers only the SSH workflow.
The SSH setup description named only the Unix-style config path despite supporting Windows. Describe the file as the SSH config, list its platform-specific paths once, and use the generic name afterward.
The overview presented implementation details before the connection workflow and overloaded the enablement section with generated config details. Lead with setup and connection steps, then consolidate the managed config and transport explanation in a final technical section.
The sidebar did not communicate that SSH-based editor and app integrations are experimental. Add the standard experimental badge metadata to the integrations entry.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Stubs a new experimental Integrations section under
content/manuals/ai/sandboxes/documenting how to connect external editors andapps to a sandbox over SSH.
https://deploy-preview-25557--docsdocker.netlify.app/ai/sandboxes/integrations/
🤖 Generated with Claude Code