Skip to content

Remove stale documentation claiming stdin support for exec(), execStream(), and startProcess() - #32391

Open
thazhemadam wants to merge 1 commit into
cloudflare:productionfrom
thazhemadam:at/remove-stdin-stale-docs
Open

Remove stale documentation claiming stdin support for exec(), execStream(), and startProcess() #32391
thazhemadam wants to merge 1 commit into
cloudflare:productionfrom
thazhemadam:at/remove-stdin-stale-docs

Conversation

@thazhemadam

Copy link
Copy Markdown

This reverts merge commit b56f39e.

Remove stale documentation claiming that exec(), execStream(), and startProcess() accept stdin input. The documentation was added in cloudflare-docs#27850 to match cloudflare/sandbox-sdk#362, but the SDK change was closed without merging in favor of a future PTY-based design.

The released SDK does not expose this option, so the current examples direct users toward an unsupported API. Keep the command reference aligned with the released implementation while
cloudflare/sandbox-sdk#357 remains unresolved.

Documentation checklist

@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Review

⚠️ 1 warning found in commit dd4af7c.

👉 Fix in your agent 👈
Fix the following review findings in PR #32391 (https://github.com/cloudflare/cloudflare-docs/pull/32391).

Before making changes, review each finding and present a brief summary table:
- For each finding, state whether you agree, disagree, or need clarification
- If you disagree (e.g. the fix requires disproportionate effort for minimal benefit,
  or the finding is factually incorrect), explain why
- If you need clarification before deciding, ask those questions
- Then share your plan for which issues to tackle and in what order

After triaging, follow this order:
1. Post a comment on this PR for any findings you are skipping, with the finding ID and your reasoning.
2. Then commit the fixes for the legitimate findings.

The comment must come before the commit — the bot reads PR comments when a new
push triggers a review, so skip comments posted after the push will be missed.

---

## Code Review

### Warnings (1)

#### CR-ccb6ef133f6d · Incomplete removal of stale stdin documentation
- **File:** `src/content/docs/sandbox/api/commands.mdx` line 117
- **Issue:** The `startProcess()` options still list `stdin` with the description "Data to pass to the command's standard input". The PR title states it removes stale stdin support documentation from `exec()`, `execStream()`, and `startProcess()`.
- **Fix:** Remove the `stdin` bullet from the `startProcess()` options if stdin is unsupported there, or update the PR title/description if `startProcess()` still supports stdin.

Code Review

This code review is in beta and may not always be helpful — use your judgment.

Warnings (1)
File Issue
sandbox/api/commands.mdx line 117 Incomplete removal of stale stdin documentation — The startProcess() options still list stdin with the description "Data to pass to the command's standard input". The PR title states it removes stale stdin support documentation from exec(), execStream(), and startProcess(). Fix: Remove the stdin bullet from the startProcess() options if stdin is unsupported there, or update the PR title/description if startProcess() still supports stdin.

Conventions

No convention issues found.

Style Guide Review

No style-guide issues found.

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.
/ignore-review-limit Permanently lifts the 2-review automatic limit for this PR. Future pushes will trigger reviews as normal.
/disable-auto-review Stops automatic reviews from triggering on future pushes to this PR. Codeowners can still run /review or /full-review manually.
/rebase Rebases the PR branch against production. On conflict, attempts to resolve automatically using AI. Stops with an explanation if confidence is not high enough.

@thazhemadam thazhemadam changed the title revert: revert "Add stdin support documentation for exec(), execStream(), and startProcess() (#27850)" Remove stale documentation claiming stdin support for exec(), execStream(), and startProcess() Jul 29, 2026
…am(), and startProcess() (cloudflare#27850)"

This reverts merge commit b56f39e.

Remove stale documentation claiming that `exec()`, `execStream()`, and
`startProcess()` accept `stdin` input. The documentation was added in
cloudflare-docs#27850 to match cloudflare/sandbox-sdk#362, but the SDK
change was closed without merging in favor of a future PTY-based design.

The released SDK does not expose this option, so the current examples
direct users toward an unsupported API. Keep the command reference
aligned with the released implementation while
cloudflare/sandbox-sdk#357 remains unresolved.
@thazhemadam
thazhemadam force-pushed the at/remove-stdin-stale-docs branch from 4c6ec9f to dd4af7c Compare July 29, 2026 08:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant