Skip to content

R2 virtual workspace docs incorrectly describe raw bucket mount instead of Workspace-backed virtual filesystem #156

@astrobot-houston

Description

@astrobot-houston

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

  1. Read the Cloudflare deployment guide at docs/deploy-cloudflare.md
  2. Follow the R2 setup instructions, which describe a raw R2 bucket mount and direct Wrangler upload workflow
  3. Observe that the described behavior does not match the actual Workspace-backed virtual filesystem semantics of the runtime

Original implementation from #155 by @stainlu

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions