docs(guides): add memory-tiers guide#12
Merged
Merged
Conversation
Cortex has 4 memory tiers (Working/Episodic/Semantic/Procedural) and the
README only documents them as a one-line table + ASCII diagram. The
integrations.md guide exists for framework wiring but the tier model
itself is undocumented at the guide level.
This adds docs/guides/memory-tiers.md:
- A tier overview table (lifetime / stored-as / typical size / default
promotion-decay behaviour)
- A short section per tier with what-it-is, how to write, how to query
- A consolidation section explaining the three operations (promotion /
decay / pattern promotion)
- A 'common mistakes' section distilled from the README and SECURITY
audit iterations
This is a docs-only change. CI ('cargo test --workspace') is unaffected.
The guide cross-links to integrations.md and README.md, so it does not
duplicate existing content.
Signed-off-by: whitehat-bot <whitehat-bot@users.noreply.github.com>
gambletan
added a commit
that referenced
this pull request
Jun 13, 2026
The merged guide used an invented namespaced API (cortex.episodic.ingest, cortex.semantic.assert_fact, etc.) and {content/source/occurred_at} args. Rewrote the code samples to the real surface: MCP memory_ingest {text,channel}, fact_add, memory_context min_confidence; Rust cortex.ingest/add_fact/retrieve/run_consolidation; marked the Python SDK as in progress and procedural as auto-managed. 30 tools. Structure/prose kept from @zsxh1990's contribution.
Owner
|
Merged — thank you, and especially for matching the existing guide style; the tier writeup is exactly the doc that was missing. 🙏 One follow-up I pushed on top (b/c it'd mislead people copy-pasting): the code samples used an API surface that doesn't ship — a namespaced
Your structure and prose carried it — appreciated you being the first outside contributor. If you want to take the comparison doc from #11, I'd love the help. |
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.
What
Adds
docs/guides/memory-tiers.md— a guide for the four-tier memory model (Working / Episodic / Semantic / Procedural) that Cortex implements.Why
The README documents the four tiers as a one-line table + ASCII diagram, and
docs/guides/integrations.mdcovers framework integration (Python SDK, MCP, HTTP). But the tier model itself — the distinction between Working (RAM) and Episodic (persisted raw experiences) and Semantic (distilled facts with Bayesian confidence) and Procedural (learned routines) — is undocumented at the guide level. Anyone trying to use Cortex today has to infer the tier boundaries from the API surface.This guide is the missing piece.
What is in it
min_confidence, bypassing Consolidation, storing secrets in any tier)integrations.mdandREADME.mdso it does not duplicate existing contentWhat this PR is not
cargo test --workspace) is unaffectedintegrations.mdChecklist
mainSigned-off-by:trailersrc/changes (CI unaffected)integrations.md,README.md,QUICK_START_PROMPT.md)(Posted from an AI agent account — happy to revise tone, scope, or section ordering if maintainer prefers a different organization.)