Skip to content

docs(memory): add TestMemoryStore documentation - #3199

Merged
opieter-aws merged 3 commits into
strands-agents:mainfrom
opieter-aws:opieter-aws/testmemorystore-doc-refs
Jul 23, 2026
Merged

docs(memory): add TestMemoryStore documentation#3199
opieter-aws merged 3 commits into
strands-agents:mainfrom
opieter-aws:opieter-aws/testmemorystore-doc-refs

Conversation

@opieter-aws

@opieter-aws opieter-aws commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Description

TestMemoryStore shipped in both SDKs but had no docs page, so the memory docs only demonstrated BedrockKnowledgeBaseStore — putting a cloud account and a provisioned knowledge base between a developer and their first taste of memory. This adds a concept page for the zero-setup store and makes it the Getting Started path on the Memory overview, so recall, injection, and extraction can be tried with one import and no infrastructure.

The page mirrors the BedrockKnowledgeBaseStore page's structure (frontmatter, opening example, Configuration/Extraction/Related sections) so the two read as siblings, and its "Scale and Limitations" section reflects the current Storage-backed implementation (fresh read per add, atomicity owned by the backend, per-instance write serialization) rather than the pre-refactor internals.

Documentation PR

This is the documentation. All changes are under site/.

Type of Change

Documentation update

Testing

Ran npm run build (Astro): 844 pages, no broken links, all --8<-- snippet references resolve, frontmatter and sourceLinks validate. Ran npm run typecheck:snippets against the current SDK so the TypeScript examples compile against the real TestMemoryStore subpath export, and Prettier over the snippet files. Also exercised the store end to end in both SDKs (default home-dir path, explicit path, persist: false ephemerality, dedup, cross-restart recall) to confirm every prose claim matches behavior.

  • I ran hatch run prepare

Checklist

  • I have read the CONTRIBUTING document
  • I have reviewed and understand every line of code in this PR, including any generated by AI tools, and I can explain why it works
  • My change is focused and reasonably small; I have split unrelated work into separate PRs
  • I have added any necessary tests that prove my fix is effective or my feature works
  • I have updated the documentation accordingly
  • I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@github-actions github-actions Bot added documentation Documentation changes, improvements, additions, content updates, site improvements, examples, guides size/m labels Jul 10, 2026
@opieter-aws
opieter-aws force-pushed the opieter-aws/testmemorystore-doc-refs branch from c976fa0 to 242cae7 Compare July 23, 2026 18:07
@opieter-aws
opieter-aws marked this pull request as ready for review July 23, 2026 18:07
@opieter-aws
opieter-aws requested a review from a team as a code owner July 23, 2026 18:07
@opieter-aws
opieter-aws requested a review from zastrowm July 23, 2026 18:07
@opieter-aws
opieter-aws removed the request for review from zastrowm July 23, 2026 18:07
@github-actions

github-actions Bot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Documentation Preview Ready

Your documentation preview has been successfully deployed!

Changed pages:

Updated at: 2026-07-23T19:50:24.121Z

Comment thread site/src/content/docs/user-guide/concepts/memory/test-memory-store.mdx Outdated
@github-actions

Copy link
Copy Markdown
Contributor

Assessment: Approve

Clean, well-scoped docs PR that adds a TestMemoryStore page and threads it through the memory overview as the zero-setup on-ramp. I verified every documented behavior against both SDK implementations and the cross-references — no accuracy issues found.

Review Categories
  • Accuracy: All claims match strands-py and strands-ts sources — default path (~/.strands/memory/<name>.json), writable defaulting to true, construction validation, content dedup, _relevanceScore key, client-side extraction (no add_messages), 5-turn cadence, and the add_memory tool name.
  • Links & snippets: Every #overview anchor resolves, all --8<-- snippet markers exist in the companion .ts files, and both sourceLinks paths point to real files.
  • Consistency: overview.mdx/.ts changes are coherent (no unused imports), and the inline-Python / snippet-tested-TS split matches the existing Bedrock KB page.
  • Nits: One trailing-whitespace suggestion inline; non-blocking.

Nicely written — the "Recall is keyword matching, not semantic search" callout and the scale/limitations framing set clear expectations for readers.

Comment thread site/src/content/docs/user-guide/concepts/memory/test-memory-store.mdx Outdated
Comment thread site/src/content/docs/user-guide/concepts/memory/test-memory-store.mdx Outdated
@github-actions

Copy link
Copy Markdown
Contributor

Assessment: Approve

Clean, accurate documentation for TestMemoryStore. I verified every code example and behavioral claim against the SDK source in both strands-py and strands-ts, and the page faithfully mirrors the established bedrock-knowledge-base.mdx conventions.

Review Categories
  • Technical accuracy: Import paths, constructor params/defaults (persist=True, default ~/.strands/memory/<name>.json, empty-name/path and max_search_results<1 rejection), add/search semantics, dedup, _relevanceScore, and the "every 5 turns" ModelExtractor extraction path all match source. Atomic-write and cross-SDK on-disk format claims verified too.
  • Structure & voice: Content-type-appropriate, one-question-per-section, <Syntax> used for language-specific identifiers, no em-dashes, terminology consistent with the lock file.
  • Snippets & build conventions: All eight --8<-- includes resolve to matching [start/end] marker pairs; each TS block pairs an imports snippet with a body snippet; sourceLinks paths exist; edits to overview.ts/overview_imports.ts leave no unused imports and keep bodies/imports in sync.
  • Minor suggestions: Two optional, non-blocking nits left inline (a search example whose tokens don't overlap as strongly as the prose implies, and a "target path" phrasing that's slightly broader than the actual error message).

Nicely done — the zero-setup framing and the honest "prototyping, not production" scoping make this an easy on-ramp for readers.

@github-actions

Copy link
Copy Markdown
Contributor

Re-reviewed the Address comments revision (ae8cb79) — all three suggestions are resolved and verified:

  • Trailing whitespace — removed (clean across all touched files).
  • Search example — query is now "which seats does the user prefer?", so seats and user overlap the stored content and _relevanceScore reflects the meaningful terms. Updated in both the Python prose block and the TS snippet, so parity holds.
  • "target path" — reworded to "raises, naming the backing file," matching the actual StorageError message.

Diff against main is 7 docs files under site/ only, no SDK source touched, no regressions. Approval stands — this is ready to merge. 🚢

@opieter-aws
opieter-aws merged commit 6f6fb65 into strands-agents:main Jul 23, 2026
16 checks passed
@opieter-aws
opieter-aws deleted the opieter-aws/testmemorystore-doc-refs branch July 23, 2026 21:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation changes, improvements, additions, content updates, site improvements, examples, guides size/m

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants