Skip to content

docs: add Vercel Eve integration guide - #320

Merged
OndrejDrapalik merged 1 commit into
mainfrom
docs/vercel-eve-guide
Jul 29, 2026
Merged

docs: add Vercel Eve integration guide#320
OndrejDrapalik merged 1 commit into
mainfrom
docs/vercel-eve-guide

Conversation

@OndrejDrapalik

Copy link
Copy Markdown
Contributor

Summary

  • Add docs/agents/eve.mdx documenting @e2b/eve-sandbox, the E2B sandbox backend for Vercel Eve — the E2B counterpart to Eve's built-in vercel() / docker() / microsandbox() / justbash() backends.
  • Cover the two-phase SandboxBackend lifecycle: build-time prewarm() capturing bootstrap + seed files into an E2B snapshot, runtime create() reconnecting by sandboxIdeveSessionKey metadata → snapshot fork.
  • Document session persistence (onTimeout: 'pause', autoResume: true, 30-minute default) and the two non-obvious consequences: shutdown() is a deliberate no-op, and reconnects intentionally do not re-apply the factory networkPolicy.
  • Document the Eve to E2B network policy mapping as a table, plus a <Warning> listing the four policies the backend rejects rather than silently weakening (subnets.deny with an allow-list, per-rule match, forwardURL, transform with a catch-all allow).
  • Add images/icons/vercel-eve.svg (Vercel mark, with a prefers-color-scheme fill swap so it stays visible on the dark theme) and a nav entry in docs.json.

Facts in the page were read from the eve-sandbox source, not inferred: defaults, option names, metadata keys, and every network-policy branch.

Test plan

  • docs.json parses and the page appears in the Agents nav between Pi and Google ADK
  • Page renders in the Mintlify preview; <Note>, <Warning>, and <CardGroup> all display
  • Icon is visible in the nav in both light and dark themes
  • Internal links resolve: /docs/template/quickstart, /docs/sandbox/persistence, /docs/sandbox, /docs/network/internet-access, /docs/sdk-reference/js-sdk
  • External links resolve: vercel.com/docs/eve, eve.dev/docs/sandbox, the GitHub repo

Known blockers before merge

  • @e2b/eve-sandbox is not published to npm yet (npm view 404s), so the npm i @e2b/eve-sandbox e2b snippet will not work until 0.1.0 ships.
  • eve-sandbox's examples/package.json pins eve ^0.18.1 while the root peer range is ^0.27.0; the page documents >= 0.27 per the peer range.

Document `@e2b/eve-sandbox`, the E2B backend for Vercel Eve's agent
sandbox, alongside Eve's built-in vercel()/docker()/microsandbox()/
justbash() backends.

Covers the two-phase SandboxBackend lifecycle (build-time prewarm into
an E2B snapshot, runtime reconnect-or-fork), session persistence via
auto-pause, and the Eve-to-E2B network policy mapping — including the
policies the backend rejects rather than silently weakening.

Adds the Vercel Eve icon with a dark-mode fill and a nav entry.
@mintlify

mintlify Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
e2b 🟢 Ready View Preview Jul 29, 2026, 2:34 PM

@beran-t beran-t 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.

lgtm

@OndrejDrapalik
OndrejDrapalik merged commit 0dc84b5 into main Jul 29, 2026
9 checks passed
@OndrejDrapalik
OndrejDrapalik deleted the docs/vercel-eve-guide branch July 29, 2026 15:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants