Skip to content

docs(sandbox-blaxel): add README with usage and configuration reference#1354

Open
nuthalapativarun wants to merge 1 commit into
VoltAgent:mainfrom
nuthalapativarun:docs/sandbox-blaxel-readme
Open

docs(sandbox-blaxel): add README with usage and configuration reference#1354
nuthalapativarun wants to merge 1 commit into
VoltAgent:mainfrom
nuthalapativarun:docs/sandbox-blaxel-readme

Conversation

@nuthalapativarun

@nuthalapativarun nuthalapativarun commented Jun 23, 2026

Copy link
Copy Markdown

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-blaxel has no README, so users have no documentation for wiring BlaxelSandbox into a VoltAgent Workspace.

What is the new behavior?

Adds a README covering installation, basic usage with Workspace, the BlaxelSandboxOptions/BlaxelSandboxConfig reference, and the Blaxel SDK's auth singleton caveat.

Notes for reviewers

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


Summary by cubic

Adds a README for @voltagent/sandbox-blaxel with install steps, basic Workspace integration, and a configuration reference. It documents BlaxelSandboxOptions/BlaxelSandboxConfig and notes the Blaxel SDK auth singleton caveat.

Written for commit 51d4abf. Summary will update on new commits.

Review in cubic

Summary by CodeRabbit

  • Documentation
    • Added comprehensive README documentation for the Blaxel sandbox provider package, including installation instructions, TypeScript integration examples, detailed configuration options with defaults (timeout, max output, poll interval), and authentication behavior notes.

@changeset-bot

changeset-bot Bot commented Jun 23, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 51d4abf

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-blaxel 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: 236459c1-0a5e-4ac9-9e24-64349f1b99ee

📥 Commits

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

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

📝 Walkthrough

Walkthrough

A new README.md is added for the @voltagent/sandbox-blaxel package, covering installation, a TypeScript usage example wiring BlaxelSandbox into a Workspace, configuration option tables, an authentication note, and the MIT license. A matching patch changeset entry is also added.

Changes

sandbox-blaxel documentation

Layer / File(s) Summary
Package README and changeset
packages/sandbox-blaxel/README.md, .changeset/sandbox-blaxel-readme.md
Adds the full README for @voltagent/sandbox-blaxel documenting installation, BlaxelSandbox/Workspace integration, BlaxelSandboxOptions/BlaxelSandboxConfig option tables with defaults, auth credential behavior, and MIT license. A patch changeset entry records the doc addition.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • VoltAgent/voltagent#1278: Directly targets the same @voltagent/sandbox-blaxel package release artifacts, updating the package version and changelog in the same packaging/docs workflow this PR contributes to.

Poem

🐇 Hippity-hop, the docs are here at last,
A README so clear, written oh so fast!
BlaxelSandbox wired, Workspace set to go,
Options and auth, all neatly in a row.
The bunny stamps "patch" with a satisfied grin~ ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding a README with usage and configuration documentation for the sandbox-blaxel package.
Description check ✅ Passed The description comprehensively covers all template sections, including commit guidelines confirmation, documentation updates, changeset additions, current behavior, new behavior, and relevant notes for reviewers.
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

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.

1 participant