Skip to content

docs(sandbox-e2b): add README with usage and configuration reference#1356

Merged
omeraplak merged 1 commit into
VoltAgent:mainfrom
nuthalapativarun:docs/sandbox-e2b-readme
Jun 30, 2026
Merged

docs(sandbox-e2b): add README with usage and configuration reference#1356
omeraplak merged 1 commit into
VoltAgent:mainfrom
nuthalapativarun:docs/sandbox-e2b-readme

Conversation

@nuthalapativarun

@nuthalapativarun nuthalapativarun commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

PR Checklist

  • Commit message follows guidelines (conventional commits: <type>(<scope>): <description>)

Bugs / Features

  • Related issue(s) linked
  • Tests for the changes have been added
  • Docs have been added / updated
  • Changesets have been added (pnpm changeset)

What is the current behavior?

@voltagent/sandbox-e2b has no README, so users have no documentation for wiring E2BSandbox into a VoltAgent Workspace.

What is the new behavior?

Adds a README covering installation, basic usage with Workspace, and the E2BSandboxOptions configuration reference.

Notes for reviewers

Mirrors the style/structure of the recently added @voltagent/server-core README (#1331).


Summary by cubic

Add a README for @voltagent/sandbox-e2b with install steps, Workspace usage, and a full E2BSandboxOptions reference. Includes a patch changeset.

Written for commit a0047ff. Summary will update on new commits.

Review in cubic

Summary by CodeRabbit

  • Documentation
    • Added comprehensive README documentation for the E2B sandbox provider, including installation instructions, TypeScript usage examples, and configuration options reference.

@changeset-bot

changeset-bot Bot commented Jun 23, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a0047ff

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@voltagent/sandbox-e2b Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4cea6d46-9b29-4bb5-83f5-81e0fe603b7a

📥 Commits

Reviewing files that changed from the base of the PR and between 0c1a1a4 and a0047ff.

📒 Files selected for processing (2)
  • .changeset/sandbox-e2b-readme.md
  • packages/sandbox-e2b/README.md

📝 Walkthrough

Walkthrough

Adds a new README.md for the packages/sandbox-e2b package documenting the @voltagent/sandbox-e2b package: description, installation, TypeScript usage example, E2BSandboxOptions reference table, getSandbox() accessor, resource links, and MIT license. A matching patch changeset entry is also added.

Changes

sandbox-e2b Documentation

Layer / File(s) Summary
sandbox-e2b README and changeset
packages/sandbox-e2b/README.md, .changeset/sandbox-e2b-readme.md
New README covers package description, installation, TypeScript usage snippet wiring E2BSandbox into an Agent/Workspace, full E2BSandboxOptions table, getSandbox() accessor, documentation links, and MIT license. Changeset records a patch bump for the documentation addition.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 A README hops into the light,
With options and snippets just right.
The sandbox is clear,
No mystery here—
E2B documented bright! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs(sandbox-e2b): add README with usage and configuration reference' directly and clearly summarizes the main change: adding comprehensive README documentation to the sandbox-e2b package.
Description check ✅ Passed The description comprehensively covers all required template sections: checklist items are completed, current vs new behavior is clearly described, docs and changesets are confirmed, and helpful reviewer notes are provided.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 2 files

Re-trigger cubic

@omeraplak
omeraplak merged commit 2b66ae3 into VoltAgent:main Jun 30, 2026
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants