Originally reported by @stainlu in #155.
All community-submitted pull requests are automatically converted to issues (bugs) & discussions (feature requests, enhancements) where they can be triaged and prioritized. Once prioritized, a PR implementation is created automatically.
Describe the Bug
The documentation across multiple packages (README.md, docs/deploy-cloudflare.md, packages/cli/README.md, packages/runtime/README.md, packages/sdk/README.md) and the JSDoc comments in packages/runtime/src/cloudflare/virtual-sandbox.ts incorrectly describe the Cloudflare R2 integration as a raw R2 bucket mount. In reality, it creates a Workspace-backed virtual filesystem. The deploy guide also provides direct Wrangler upload instructions instead of the correct workspace seeding approach, which could mislead users into an unsupported workflow.
Refs #153.
Expected Behavior
Documentation and source-level JSDoc should accurately describe the R2 virtual workspace as a Workspace-backed virtual filesystem, and the Cloudflare deploy guide should show the correct seeding workflow rather than direct Wrangler upload steps.
Steps to Reproduce
- Read the Cloudflare deployment guide at
docs/deploy-cloudflare.md
- Follow the R2 setup instructions, which describe a raw R2 bucket mount and direct Wrangler upload workflow
- Observe that the described behavior does not match the actual Workspace-backed virtual filesystem semantics of the runtime
Original implementation from #155 by @stainlu
Describe the Bug
The documentation across multiple packages (
README.md,docs/deploy-cloudflare.md,packages/cli/README.md,packages/runtime/README.md,packages/sdk/README.md) and the JSDoc comments inpackages/runtime/src/cloudflare/virtual-sandbox.tsincorrectly describe the Cloudflare R2 integration as a raw R2 bucket mount. In reality, it creates a Workspace-backed virtual filesystem. The deploy guide also provides direct Wrangler upload instructions instead of the correct workspace seeding approach, which could mislead users into an unsupported workflow.Refs #153.
Expected Behavior
Documentation and source-level JSDoc should accurately describe the R2 virtual workspace as a Workspace-backed virtual filesystem, and the Cloudflare deploy guide should show the correct seeding workflow rather than direct Wrangler upload steps.
Steps to Reproduce
docs/deploy-cloudflare.mdOriginal implementation from #155 by @stainlu