Repository navigation
[Sandbox] Define terms and close gaps in the guides - #34568
Closed
ghostwriternr wants to merge 7 commits into
Closed
ghostwriternr wants to merge 7 commits into
ghostwriternr wants to merge 7 commits into
Conversation
The overview relied on "instance", "Durable Object", "image", and "microVM" without saying what they are, explained Linux isolation that Choose a sandbox environment also explains, and showed code excerpts with undeclared names and a literal "$today". The concept pages used snapshot, alarm, SIGTERM, root, and binding before defining them, and restated limits that the Containers pages own. Define each term where a page first relies on it and link the page that owns it, leave isolation to the concepts page, introduce each name in the excerpts, and link the snapshot retention limit instead of restating it.
The get-started pages used POST, stdout, binding, Durable Object, and instance without defining them, asked for Docker only after the step that needs it, and did not say that the request goes in a second terminal. The two tutorials did not say they need the Workers Paid plan or how to delete what they deploy, and the runner told readers to poll until succeeded or failed, which a lost task never reaches. Define each term where it first matters, start Docker before wrangler dev, name the second terminal, link the plan requirement, add clean-up steps, and stop polling on every state that is not running.
The command guides relied on a restarted Durable Object, process groups, pseudo-terminals, and the main process without saying what they are, stated exact stop times that depend on the inactivity timeout, and did not say which working directory or variables a background process gets. The chart steps checked the result before asking for a deploy. Define each term at first use and link Sandbox lifetime, let the timeout own stop times, say that a background process receives only PATH unless startProcess() passes more, and deploy before the check.
The file and manage pages used instance, snapshot, alarm, prefix, and FUSE without saying what they are, restated snapshot contents and retention that Sandbox lifetime and the Containers limits own, and replaced the whole src/index.ts in a step that later steps extend. The listing page did not say how to read further pages of instances. Define each term at first use, link the owning pages instead of restating them, say that a snapshot works only with its image, keep the default export until the step that replaces it, and describe pagination.
The preview and network pages relied on entrypoint, intercept, certificate authority, origin, and a restarted Durable Object without saying what they are, and code comments carried the explanation of why Node.js and Git need the CA file. The network overview linked an outbound guide written for another class. Define each term at first use, move the CA explanation into the text after each step, link the activity rules where the pages rely on them, and point the overview to the intercept API sections.
The CLI agent guides told readers to poll until a task succeeded or failed, so a lost task polled forever. Claude Managed Agents said nothing about which key reaches its sandboxes or that its dashboard, API, and terminal routes have no authentication, while the overview implied only three templates pass a credential. The vendor guides used Durable Object, cron trigger, snapshot, executor, and binding without saying what they are, and restated template defaults. Poll while a task is running and link the outcome states, add a security section to Claude Managed Agents from the template source, define each term at first use, and link template defaults instead of copying them.
The reference pages left the configuration, FUSE, gateway, and upstream fields of an S3 mount inspection undefined, applied the missing-cwd rule to absolute paths, did not say when a streamed readFile() ends, and used s3fs, FUSE, Durable Object, and container image without saying what they are. Each class page also restated that the package does not manage the container. Document every inspection field and status from the package source, limit the cwd rule to relative paths, say how a read finishes or aborts, define the terms, and state the container rule once on the package index.
🚀 Deploying Preview to Cloudflare 🚀Preview URL: https://sandbox-audit-terms.previews.developers.cloudflare.com (commit c4dbd52)This URL reflects your latest Preview deploymentPreview Deployments by commit
|
Contributor
Contributor
|
@ghostwriternr This draft pull request has had no activity for 3 days. It will close after 7 days of inactivity. Transition to ready for review if ready. A codeowner can comment |
Contributor
|
@ghostwriternr Closing this draft pull request after 7 days of inactivity. Re-open at a later date and transition to ready for review when you are ready if you seek review. |
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
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.
Summary
Many Sandbox guides used terms such as instance, Durable Object, snapshot, alarm, entrypoint, intercept, process group, and FUSE before defining them, or restated limits that the Containers and Durable Objects docs own. Some steps also failed in ways a reader would hit.
Each page now defines a term where it first relies on it, and links the page that owns a limit or behavior instead of restating it. Other fixes:
succeededorfailed, so alosttask polled forever. They now poll while the state isrunningand link the outcome states.wrangler devand names the second terminal. The two tutorials state the Workers Paid plan requirement and how to delete what they deploy.PATHunlessstartProcess()passes more.cwdrule only to relative paths.Documentation checklist