Skip to content

docs: add agent-memory concept guides (how memory works, where to store data)#484

Open
reemsabawi-mystenlabs wants to merge 4 commits into
devfrom
claude/wm-concept-guides-jbevl2
Open

docs: add agent-memory concept guides (how memory works, where to store data)#484
reemsabawi-mystenlabs wants to merge 4 commits into
devfrom
claude/wm-concept-guides-jbevl2

Conversation

@reemsabawi-mystenlabs

Copy link
Copy Markdown
Collaborator

Description

Adds two net-new Walrus Memory concept/discovery pages under Fundamentals → Concepts, both children of the BEDU-904 docs-set spine. They target top-of-funnel, solution-unaware search and link down into the existing SDK and concept docs rather than duplicating them.

  • fundamentals/concepts/how-agent-memory-works (BEDU-866) — a conceptual pillar: what agent memory is, why the model's context window is not memory, short-term vs long-term memory, and how long-term (semantic) memory works with embeddings and vector search. Closes with how Walrus Memory implements the embed/store/recall loop and links to the Agent Storage Loop and Headless SDK Setup.
  • fundamentals/concepts/where-to-store-agent-data (BEDU-870) — a decision guide: compares provider-native memory, managed and self-hosted vector databases, and Walrus Memory across persistence, portability, ownership, and verifiability, with a capability table and "choose X when" guidance.

Both are registered in docs.json in the Concepts group.

Notes

  • Competitor comparisons in the decision guide are kept at the category level (managed vs self-hosted vector database, provider-native memory) rather than making specific claims about named products, so nothing is asserted that the docs can't back up.
  • Applied the Sui documentation style conventions: sentence-case headings, second person, no em dashes or Latin abbreviations, colon-style bold-label bullets, ## References-style card links, title/description frontmatter.
  • Every internal link resolves to an existing page; docs.json parses.

Test plan

  • Grounded all product claims (remember/recall/analyze, embeddings, namespaces, encryption with Seal, onchain ownership, restore rebuilding the index, blob_id on recall) in the existing Walrus Memory docs and SDK surface. No invented APIs.
  • Verified docs.json is valid JSON and all internal links point to existing pages.
  • Did not run a local Mintlify build (toolchain not set up here); please let docs CI confirm.

🤖 Generated with Claude Code

https://claude.ai/code/session_017oS4PdhkXAzbfhJx2ZhRvh


Generated by Claude Code

…re data)

Net-new Walrus Memory concept/discovery pages under Fundamentals > Concepts:
- how-agent-memory-works: context window vs persistent memory, short/long-term
  memory, and how semantic recall works with embeddings (BEDU-866)
- where-to-store-agent-data: decision guide comparing provider-native memory,
  managed/self-hosted vector databases, and Walrus Memory (BEDU-870)

Both registered in docs.json; children of the BEDU-904 docs-set spine.
@jessiemongeon1

jessiemongeon1 commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator

Style Guide Audit

All 2 file(s) pass the style guide audit.

- Add keywords frontmatter to both pages
- Reword example query to avoid first person
- Drop quotation marks around the vector-database phrasing
Comment thread docs/fundamentals/concepts/where-to-store-agent-data.md Outdated
Comment thread docs/fundamentals/concepts/where-to-store-agent-data.md Outdated
Comment thread docs/fundamentals/concepts/where-to-store-agent-data.md Outdated
Comment thread docs/fundamentals/concepts/where-to-store-agent-data.md Outdated
Comment thread docs/fundamentals/concepts/where-to-store-agent-data.md Outdated
Comment thread docs/fundamentals/concepts/how-agent-memory-works.md Outdated
Comment thread docs/fundamentals/concepts/how-agent-memory-works.md Outdated
Comment thread docs/fundamentals/concepts/how-agent-memory-works.md Outdated
Comment thread docs/fundamentals/concepts/how-agent-memory-works.md Outdated
Comment thread docs/fundamentals/concepts/how-agent-memory-works.md Outdated
Address Jessie's review on #484:
- Convert bold-label bullet lists to flowing prose on both pages
- Remove meta preamble; lead with a direct answer (AEO/GEO)
- Fix tables: bold headers, plain data cells, labeled first column
- Remove italics
- Replace next-steps card groups with inline prose links

reemsabawi-mystenlabs commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator Author

Reworked both pages in f5fd03e. You're right that they read AI-generated — I've done a manual prose pass rather than another generation:

  • Converted the bold-label bullet lists to flowing prose on both pages (the context-window points, the options, "choose based on need", and the vector-database comparison are all prose now).
  • Removed the meta preamble and lead with a direct answer for AEO/GEO.
  • Fixed the tables: bold header row, plain data cells, and labeled the empty top-left cell.
  • Removed the italics.
  • Replaced the next-steps card groups with inline prose links.

I've also folded these into my pre-push style checklist (prose over lists, no italics, no preamble, table formatting) so they don't recur.


Generated by Claude Code

Address style-guide audit: rewrite passive constructions
(memories are encrypted, ownership is enforced, vector is saved,
query is embedded, is enforced by Sui) into active voice, and
change causal 'since' to 'because'.
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.

3 participants