Skip to content

docs: migrate guides and snippets to v3 APIs - #1457

Closed
zrosenbauer wants to merge 4 commits into
VoltAgent:nextfrom
zrosenbauer:docs/v3-api-migration
Closed

zrosenbauer wants to merge 4 commits into
VoltAgent:nextfrom
zrosenbauer:docs/v3-api-migration

Conversation

@zrosenbauer

@zrosenbauer zrosenbauer commented Oct 14, 2026 •

Copy link
Copy Markdown
Collaborator

PR Checklist

  • Commit message follows repository conventions.

Bugs / Features

  • Related guides, package READMEs, recipes, and rendered snippets updated.
  • Existing v3 release notes aligned with canonical APIs.
  • Tests: documentation-specific changes validated with lint, formatting, generation, and source audits.

What is the current behavior?

Documentation mixes constructor-based examples, implicit startup, and older tool/workflow names with the v3 authoring surface.

What is the new behavior?

  • Migrate current guides, integrations, deployment examples, recipes, package READMEs, and tutorial/landing-page snippets.
  • Document constructor-to-factory migration, type-only exports, explicit ready(), and shutdown.
  • Align tool, workflow, and scorer documentation and release notes while retaining documented compatibility helpers.
  • Update generated provider examples and their generator: handle formatted registry types, preserve manually maintained provider pages, and retain existing fallback guidance.

Testing

  • Repository lint passed with six existing complexity warnings.
  • Changed Markdown/MDX formatting, whitespace checks, and commit hooks passed.
  • Model documentation generation completed for 80 providers and 2,195 registry models.
  • Active documentation constructor audit completed; explicit migration-before examples and historical blog posts retain older syntax.
  • Website build is blocked by local dependency resolution: missing webpack/lib/ContextReplacementPlugin.
  • Website typecheck is blocked by missing @docusaurus/theme-classic type definitions. No dependency or lockfile changes are included.
  • Preceding layers have passing core/server test suites and relevant package build/type checks; details are in their PRs.

Notes for reviewers

Layer 4 of 4. Depends on #1454, #1455, and #1456.

This cross-fork draft targets upstream next, so its diff initially includes layers 1–3. The documentation-specific commit is 57e57043. Rebase this branch onto next after its dependencies merge, preserving that commit.

Review and merge bottom-up: #1454 → #1455 → #1456 → this PR.

The stack starts from upstream next at 783491fa. Local and fork main/next were synchronized with upstream before publication.


Summary by cubic

Migrates all guides, examples, package READMEs, and rendered snippets from constructor-based APIs to the canonical v3 authoring factories, and updates examples to explicitly await application readiness.

  • Replaces new Agent(...), tool(...), createWorkflow(...), and new VoltAgent(...) with defineAgent(...), defineTool(...), defineWorkflow(...), and voltagent(...).
  • Adds await voltagent(...).ready() in example code; app startup no longer begins at construction.
  • Updates changesets, release notes, and docs/testing.md to match the canonical API names, and clarifies that createTool returns structural parameters-style tool objects.
  • Updates generated provider documentation: 80 providers and 2,195 registry models regenerated, with manually maintained provider pages preserved.

Written for commit 57e5704. Summary will update on new commits.

View guided diff

@coderabbitai

coderabbitai Bot commented Oct 14, 2026

Copy link
Copy Markdown
Contributor

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@changeset-bot

changeset-bot Bot commented Oct 14, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 57e5704

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

This PR includes changesets to release 29 packages
Name Type
@voltagent/core Major
@voltagent/scorers Major
@voltagent/server-hono Major
@voltagent/server-core Major
@voltagent/cli Major
create-voltagent-app Major
@voltagent/a2a-server Major
@voltagent/ag-ui Major
@voltagent/cloudflare-d1 Major
@voltagent/docs-mcp Major
@voltagent/evals Major
@voltagent/internal Major
@voltagent/langfuse-exporter Major
@voltagent/libsql Major
@voltagent/logger Major
@voltagent/mcp-server Major
@voltagent/postgres Major
@voltagent/rag Major
@voltagent/resumable-streams Major
@voltagent/sandbox-blaxel Major
@voltagent/sandbox-daytona Major
@voltagent/sandbox-e2b Major
@voltagent/sdk Major
@voltagent/server-elysia Major
@voltagent/serverless-hono Major
@voltagent/supabase Major
@voltagent/vercel-ai-exporter Major
@voltagent/voice Major
@voltagent/voltagent-memory Major

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

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