Uh oh!
There was an error while loading. Please reload this page.
docs: make sandboxes getting-started more agent-friendly - #446
Open
sophiajwitt wants to merge 2 commits into
Open
docs: make sandboxes getting-started more agent-friendly#446sophiajwitt wants to merge 2 commits into
sophiajwitt wants to merge 2 commits into
Conversation
Two additive changes to reduce first-run friction for developers and coding agents copy-pasting from the quickstart: - Surface authentication as a prerequisite with a Note directly above the quickstarts, so readers who jump straight to the code know they need PORTER_SANDBOX_API_KEY / PORTER_CLUSTER_ID when running outside the cluster (previously only covered in an earlier section that's easy to skip). - Add a Troubleshooting section covering the two predictable first failures - exec against an already-exited sandbox, and auth errors outside the cluster - and linking the Python/TypeScript SDK error references. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The sidebar mixed singular and plural: "Sandboxes Overview / Getting Started / CLI" alongside "Sandbox Networking" and "Sandbox Capacity". Make the descriptive guide-page titles consistently plural to match the section name. The "Sandbox SDK" pages keep the singular product name (the package is porter-sandbox). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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 freeto 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
Two additive edits to
sandboxes/getting-started.mdxthat reduce first-run friction for developers and coding agents:<Note>directly above the quickstarts spells out thatPORTER_SANDBOX_API_KEY/PORTER_CLUSTER_IDare needed when running outside the cluster. This info already existed, but under an earlier "Calling from outside the cluster" heading that anyone jumping straight to "Python quickstart" skips — the most common first-run auth failure.execagainst an already-exited sandbox → links the existing "Keep a sandbox alive for exec" section; auth errors outside the cluster) and links the Python/TypeScript SDK error references.No example code semantics changed.
Note on stacking
Based on
sophia/sandbox-docs-agent-friendly(PR #445). Retarget tomainonce that merges. Kept separate so the structural move (#445) and this content change review independently.Not included (already fine / no repo change)
llms.txtis already live at docs.porter.run and lists every sandbox page including the SDK subtree — it regenerates automatically, so nothing to change here.🤖 Generated with Claude Code