Repository navigation
docs: migrate guides and snippets to v3 APIs - #1457
Closed
zrosenbauer wants to merge 4 commits into
Closed
zrosenbauer wants to merge 4 commits into
zrosenbauer wants to merge 4 commits into
Conversation
Contributor
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: true
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. Comment |
🦋 Changeset detectedLatest commit: 57e5704 The changes in this PR will be included in the next version bump. This PR includes changesets to release 29 packages
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 |
3 tasks done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Checklist
Bugs / Features
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?
ready(), and shutdown.Testing
webpack/lib/ContextReplacementPlugin.@docusaurus/theme-classictype definitions. No dependency or lockfile changes are included.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 is57e57043. Rebase this branch ontonextafter its dependencies merge, preserving that commit.Review and merge bottom-up: #1454 → #1455 → #1456 → this PR.
The stack starts from upstream
nextat783491fa. Local and forkmain/nextwere 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.
new Agent(...),tool(...),createWorkflow(...), andnew VoltAgent(...)withdefineAgent(...),defineTool(...),defineWorkflow(...), andvoltagent(...).await voltagent(...).ready()in example code; app startup no longer begins at construction.docs/testing.mdto match the canonical API names, and clarifies thatcreateToolreturns structural parameters-style tool objects.Written for commit 57e5704. Summary will update on new commits.