Skip to content

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

Description

@dongjiang1989

Problem

There is no unified installation & usage documentation for users to deploy and run the component on PI, OpenClaw and Hermes platforms. Meanwhile, developers cannot clearly learn the performance and feature differences between this component and native memory implementations, which increases the access cost for new users.

Proposed Change

  1. Add complete installation and step-by-step usage guides targeting three platforms: PI, OpenClaw, Hermes.
  2. Add a comparison section to contrast the capabilities, overhead and applicable scenarios between this component and native memory.
  3. Organize all samples and comparison content under unified Markdown docs for easy lookup.

Design Boundary Check

Boundary Answer
Keeps Markdown/frontmatter as source of truth? Yes
Keeps full-index recall instead of embedding/BM25/top-k retrieval? Yes
Keeps @memflywheel/core free of direct LLM calls? Yes
Fits Agent Harness lifecycle integration? Yes

Alternatives Considered

  1. Create gh-pages branch to host website, enable automatic deployment for memory core

Metadata

Metadata

Assignees

Labels

enhancementNew feature or requesthelp wantedExtra attention is needed

Fields

No fields configured for Feature.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions