Skip to content

docs(sandbox-daytona): add README with usage and configuration reference#1355

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

docs(sandbox-daytona): add README with usage and configuration reference#1355
nuthalapativarun wants to merge 1 commit into
VoltAgent:mainfrom
nuthalapativarun:docs/sandbox-daytona-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-daytona has no README, so users have no documentation for wiring DaytonaSandbox into a VoltAgent Workspace.

What is the new behavior?

Adds a README covering installation, basic usage with Workspace, and the DaytonaSandboxOptions 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-daytona with install, basic Workspace usage, and a DaytonaSandboxOptions reference. This gives clear docs for running agents in a Daytona-backed sandbox.

Written for commit 76e76e4. Summary will update on new commits.

Review in cubic

Summary by CodeRabbit

  • Documentation
    • Added comprehensive README documentation for the sandbox-daytona package, including installation instructions, TypeScript usage examples, configuration options, and resource links.

@changeset-bot

changeset-bot Bot commented Jun 23, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 76e76e4

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-daytona 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: bdf7bc8a-ec20-4e31-8ac9-b5a85968b3e2

📥 Commits

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

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

📝 Walkthrough

Walkthrough

Adds a new README.md for the @voltagent/sandbox-daytona package, covering installation, a TypeScript usage example, a DaytonaSandboxOptions configuration reference, documentation links, and the MIT license. A matching patch changeset entry is also added.

Changes

sandbox-daytona README and changeset

Layer / File(s) Summary
README and changeset
packages/sandbox-daytona/README.md, .changeset/sandbox-daytona-readme.md
Creates the full README with install instructions, a DaytonaSandbox/Agent/Workspace usage example, a DaytonaSandboxOptions configuration table, documentation links, and MIT license. Adds a patch changeset entry for @voltagent/sandbox-daytona.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A sandbox grows tidy and bright,
With README docs now in plain sight.
🐇 The rabbit hops in, reads the guide,
Finds install steps and options inside—
Then patches the version with delight! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding a README with usage and configuration reference for the sandbox-daytona package.
Description check ✅ Passed The PR description comprehensively covers all required template sections with clear information about current behavior, new behavior, and relevant notes.
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