You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This adds documentation for the named tunnels API in Sandbox SDK. It also updates references and mentions of exposePorts() to suggest using named tunnels instead.
⚠️ 2 warnings and 1 suggestion found in full PR diff.
Warnings (2)
File
Issue
sandbox/api/tunnels.mdx line 3
Internet (as proper noun) — Frontmatter description uses 'public internet' Fix: Change to 'public Internet'
sandbox/api/tunnels.mdx line 13
Internet (as proper noun) — Prose uses 'public internet' Fix: Change to 'public Internet'
Suggestions (1)
File
Issue
sandbox/guides/expose-services.mdx line 18
Semicolons in prose — Line joins two independent clauses with a semicolon: Quick tunnels give you a zero-config *.trycloudflare.com URL; named tunnels bind a stable . hostname. Fix: Break into two sentences.
Commands
Only codeowners can run commands. Post a comment with the command to trigger it.
Command
Description
/review
Runs a review now. Incremental if a prior review exists, full if not.
/full-review
Re-reviews the entire PR diff from scratch, ignoring incremental history. Useful after a rebase, when you want a fresh review, or if the bot gets out of sync and reports issues that no longer exist.
Review posted on PR #31104. Added label: documentation.
What the PR changes
Expands the sandbox.tunnels API reference to document named tunnels (sandbox.tunnels.get(port, { name })), which bind stable hostnames on a user-controlled zone. It also updates callouts across ports.mdx, expose-services.mdx, and production-deployment.mdx to recommend named tunnels over exposePort() for most public-URL use cases.
Issues found
CRITICAL | src/content/docs/sandbox/api/tunnels.mdx:167 — Unescaped <name>.<your-zone> in prose will break the MDX build. Must be wrapped in backticks.
HIGH | src/content/docs/sandbox/api/tunnels.mdx:261–288 — The named-tunnels TS example is a bare ts fence. Workers JS/TS examples must use <TypeScriptExample>.
MEDIUM | src/content/docs/sandbox/api/tunnels.mdx:206 — API reference link /api/operations/permission-groups-list-permission-groups is missing its trailing slash.
MEDIUM | src/content/docs/sandbox/api/tunnels.mdx:210 — curl block uses angle-bracket placeholder <YOUR_GLOBAL_API_KEY_OR_EXISTING_TOKEN>; the style guide requires $VARIABLE_NAME shell-variable format in API examples.
MEDIUM | src/content/docs/sandbox/api/tunnels.mdx:338 — Same $VARIABLE_NAME issue with <account-id> in the second curl block.
LOW | src/content/docs/sandbox/api/tunnels.mdx:30 — New line uses see; style guide prefers refer to.
LOW | src/content/docs/sandbox/api/tunnels.mdx:234 — CLOUDFLARE_ACCOUNT_ID and CLOUDFLARE_ZONE_ID in prose should be monospace.
Out-of-scope notes HTTP/Websocket on line 28 should be HTTP/WebSocket, but the casing is pre-existing (the PR only changed the verb from will throw to throws). The No musl/Alpine support requirement was removed from the page in this PR; verify that named tunnels still do not work on musl, or re-add that limitation if it still applies.
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
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.
aron-cf
requested review from
a team,
ghostwriternr,
scuffi and
whoiskatrin
as code owners
![ask-bonk[bot]](https://avatars.githubusercontent.com/in/2454580?s=60&v=4){kind=small}
Summary
This adds documentation for the named tunnels API in Sandbox SDK. It also updates references and mentions of exposePorts() to suggest using named tunnels instead.
Documentation checklist