Skip to content

docs: add host-native memory comparison guide - #39

Open
FenjuFu wants to merge 2 commits into
mainfrom
docs/native-memory-comparison
Open

docs: add host-native memory comparison guide#39
FenjuFu wants to merge 2 commits into
mainfrom
docs/native-memory-comparison

Conversation

@FenjuFu

@FenjuFu FenjuFu commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Which issue(s) this PR fixes:

Fixes #23

Summary

  • Add docs/comparison.md contrasting MemFlywheel with host-native memory implementations:
    • what actually changes per host (additive on Pi/OpenCode, replacing on Hermes/OpenClaw, and how to switch back),
    • capability comparison (recall, extraction, dream, learned skills, evidence, audit, privacy, portability, scaling),
    • honest runtime-overhead table (prompt injection cap, turn-end extraction, dream gates, optional embedding pre-recall),
    • "when to use which" guidance, including the recall-only middle ground.
  • Link the new page from the documentation tables in README.md and README.zh.md.

Per-platform installation and step-by-step usage already live in the README Quick Start and docs/integrations.md (Pi / Hermes / OpenClaw / OpenCode, each with verification tables), so this PR completes the remaining piece of #23 — the native-memory comparison — and wires everything together from the READMEs for easy lookup.

Checks

  • pnpm run ci
  • No old project names, private paths, credentials, or AI-signature footers
  • Package metadata still points to iflytek/memflywheel
  • Core does not call LLMs directly
  • Recall remains full-index, with no embedding/BM25/top-k/vector retrieval

Special notes for reviewers

Docs-only change; all claims are grounded in docs/architecture.md / docs/integrations.md (index caps, dream gates, installer behavior, memory-slot semantics).

Document what changes on each host when MemFlywheel replaces or extends
the native memory implementation, the capability and runtime-overhead
trade-offs, and when staying on native memory is the better choice.
Link the new page from both README documentation tables.

Signed-off-by: FenjuFu <92919259+FenjuFu@users.noreply.github.com>
Signed-off-by: FenjuFu <92919259+FenjuFu@users.noreply.github.com>
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.

feat: Add installation & usage docs for PI / OpenClaw / Hermes, plus comparison with native memory

1 participant