docs(voltagent-memory): add README with usage examples and config reference#1350
docs(voltagent-memory): add README with usage examples and config reference#1350nuthalapativarun wants to merge 2 commits into
Conversation
🦋 Changeset detectedLatest commit: 1384080 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughAdds a new Changesvoltagent-memory documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
1 issue found across 2 files
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
The README incorrectly stated that the adapter falls back to the first managed database when neither databaseId nor databaseName is provided. In reality, findTargetDatabase() returns undefined in that case and initialize() throws an error. Updated the docs to match actual behavior. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Fixed — updated the README to accurately describe the behavior: when neither |
PR Checklist
<type>(<scope>): <description>)Bugs / Features
pnpm changeset)What is the current behavior?
@voltagent/voltagent-memoryhas no README, so users have no documentation for installing or configuring theManagedMemoryAdapterandManagedMemoryVectorAdapter.What is the new behavior?
Adds a README covering installation, VoltOps credential setup, usage examples for both the memory adapter and the vector adapter, and their configuration options.
Notes for reviewers
Mirrors the style/structure of the recently added
@voltagent/server-coreREADME (#1331).Summary by cubic
Adds a README for
@voltagent/voltagent-memorywith install steps, VoltOps key setup, quick-start examples forManagedMemoryAdapterandManagedMemoryVectorAdapter, and an options reference. Clarifies behavior: there is no fallback database—if neitherdatabaseIdnordatabaseNameis provided,initialize()throws an error.Written for commit 1384080. Summary will update on new commits.
Summary by CodeRabbit