docs: migrate guides and snippets to v3 APIs

Draft
ZR
4d ago
+3346-2617

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.