Skip to content

docs(voltagent-memory): add README with usage examples and config reference#1350

Open
nuthalapativarun wants to merge 2 commits into
VoltAgent:mainfrom
nuthalapativarun:docs/voltagent-memory-readme
Open

docs(voltagent-memory): add README with usage examples and config reference#1350
nuthalapativarun wants to merge 2 commits into
VoltAgent:mainfrom
nuthalapativarun:docs/voltagent-memory-readme

Conversation

@nuthalapativarun

@nuthalapativarun nuthalapativarun commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

PR Checklist

  • Commit message follows guidelines (conventional commits: <type>(<scope>): <description>)

Bugs / Features

  • Related issue(s) linked
  • Tests for the changes have been added
  • Docs have been added / updated
  • Changesets have been added (pnpm changeset)

What is the current behavior?

@voltagent/voltagent-memory has no README, so users have no documentation for installing or configuring the ManagedMemoryAdapter and ManagedMemoryVectorAdapter.

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-core README (#1331).


Summary by cubic

Adds a README for @voltagent/voltagent-memory with install steps, VoltOps key setup, quick-start examples for ManagedMemoryAdapter and ManagedMemoryVectorAdapter, and an options reference. Clarifies behavior: there is no fallback database—if neither databaseId nor databaseName is provided, initialize() throws an error.

Written for commit 1384080. Summary will update on new commits.

Review in cubic

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive README for the memory adapters package, documenting managed memory functionality, including persistence of conversations, messages, working memory, and workflow state via VoltOps. Includes installation steps, credential/setup options, and TypeScript usage examples for both standard and vector memory adapters, plus a details section for configuration requirements.

@changeset-bot

changeset-bot Bot commented Jun 23, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1384080

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

This PR includes changesets to release 1 package
Name Type
@voltagent/voltagent-memory Patch

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

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ed284442-d85f-4155-a26f-81128c5e1543

📥 Commits

Reviewing files that changed from the base of the PR and between 74c2dc4 and 1384080.

📒 Files selected for processing (1)
  • packages/voltagent-memory/README.md
✅ Files skipped from review due to trivial changes (1)
  • packages/voltagent-memory/README.md

📝 Walkthrough

Walkthrough

Adds a new README.md for packages/voltagent-memory covering installation, VoltOps setup, adapter usage, options, links, and license information. A Changesets file records a patch release for the documentation update.

Changes

voltagent-memory documentation

Layer / File(s) Summary
Package README and changeset
packages/voltagent-memory/README.md, .changeset/voltagent-memory-readme.md
Adds the full README for @voltagent/voltagent-memory with installation, VoltOps credential setup, ManagedMemoryAdapter and ManagedMemoryVectorAdapter usage, the options table, documentation links, and MIT license notice, plus a patch changeset entry.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 A README hops in with a cheerful thump,
And a patch notes file gives it a bump.
Install, configure, then memory takes flight,
With adapters documented just right.
The docs are here — all cozy and bright!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the main change: adding a README with usage examples and configuration reference for voltagent-memory.
Description check ✅ Passed The description covers the template’s main sections with current/new behavior, docs and changesets notes, and reviewer context.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@cubic-dev-ai cubic-dev-ai Bot 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.

1 issue found across 2 files

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread packages/voltagent-memory/README.md
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>
@nuthalapativarun

Copy link
Copy Markdown
Contributor Author

Fixed — updated the README to accurately describe the behavior: when neither databaseId nor databaseName is provided, initialize() throws an error rather than falling back to the first managed database. The docs now match the actual findTargetDatabase() implementation.

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