docs: withdraw the OpenClaw integration claims
The docs described a "drop-in" OpenClaw memory backend enabled with `memory.backend = "clawhdf5"`. Checked against OpenClaw's source and docs (v2026.2.26 through v2026.9.6): that config was never valid — v2026.2-v2026.7 accepted only "builtin"/"qmd" and rejected unknown keys, so a Gateway given it refuses to start, and v2026.8.1 (OpenClaw 2.0) removed the key. No plugin was ever built (no manifest, no registration, no tools), nothing was tested against OpenClaw, the linked github.com/redclawsystems/openclaw is a 404, and @redclaw/clawhdf5 was never published. Decision (2026-09-25): not pursuing an OpenClaw plugin for now; ZeroClaw is the integration target. - Remove openclaw-integration.md, openclaw-config.md and migration-guide.md; add docs/openclaw.md: the status, what a memory plugin needs against v2026.9.6 (plugins.slots.memory, manifest with kind "memory", registerMemoryCapability / MemorySearchManager, prebuilt native packages), and what this repo has as building blocks. - README, QUICKSTART, USE_CASES, ROADMAP (Track 7 withdrawn), CLAUDE.md and the `openclaw` module docs describe ClawhdfBackend as what it is: a Markdown-oriented library backend, not an OpenClaw plugin. The QUICKSTART example is corrected (the old one called a three-argument create that does not exist) and states its limits. - packages/clawhdf5-node: marked unpublished and broken, "private": true so it cannot be published by accident; its bugs (snake_case vs camelCase fields, wrong addon path, no way to store an embedding, wrong WAL name) are recorded in docs/known-issues.md. - Two broken rustdoc links fixed along the way. Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
This commit is contained in:
@@ -203,7 +203,7 @@ impl ImportanceScorer {
|
||||
/// Novelty score: 1.0 − max cosine similarity against all existing records.
|
||||
/// Returns 1.0 when there are no existing memories.
|
||||
///
|
||||
/// Same result as [`Self::cosine_similarity`] against each record, but the
|
||||
/// Same result as the reference cosine similarity against each record, but the
|
||||
/// new embedding's norm is computed once rather than per record, each
|
||||
/// record costs one fused pass (dot product and its norm together) rather
|
||||
/// than three, and a large working set is scored in parallel. Every insert
|
||||
|
||||
@@ -1,10 +1,12 @@
|
||||
//! OpenClaw Integration Layer.
|
||||
//! A Markdown-oriented memory backend over [`crate::HDF5Memory`].
|
||||
//!
|
||||
//! Bridge between OpenClaw agent gateway (Markdown + sqlite-vec) and the
|
||||
//! clawhdf5 HDF5-backed memory backend. Provides:
|
||||
//! Named for OpenClaw, whose workspace memory is Markdown, but **not an
|
||||
//! OpenClaw plugin**: nothing here registers with OpenClaw, and the
|
||||
//! integration it was written for never worked (see `docs/openclaw.md`).
|
||||
//! Provides:
|
||||
//!
|
||||
//! - [`MemoryBackend`] — the trait OpenClaw implements against.
|
||||
//! - [`ClawhdfBackend`] — concrete HDF5-backed implementation.
|
||||
//! - [`MemoryBackend`] — search / read back / write / ingest / export.
|
||||
//! - [`ClawhdfBackend`] — the HDF5-backed implementation.
|
||||
//! - [`MarkdownParser`] — splits Markdown into [`MarkdownSection`] records.
|
||||
//! - [`MarkdownExporter`] — renders sections back to Markdown text.
|
||||
|
||||
@@ -61,7 +63,8 @@ pub struct BackendStats {
|
||||
// MemoryBackend trait
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
|
||||
/// Interface that OpenClaw uses to interact with a memory backend.
|
||||
/// A Markdown-oriented memory backend: search, read back by path, write,
|
||||
/// ingest and export.
|
||||
///
|
||||
/// Implementors provide persistent storage, full-text + vector search,
|
||||
/// Markdown ingestion / export, and statistics.
|
||||
@@ -318,7 +321,7 @@ impl MarkdownExporter {
|
||||
///
|
||||
/// # Path mapping
|
||||
///
|
||||
/// OpenClaw addresses memories by file path (e.g. `"memory/user.md"`).
|
||||
/// Memories are addressed by file path (e.g. `"memory/user.md"`).
|
||||
/// Internally every [`MemoryEntry`] stores the originating path as its
|
||||
/// `source_channel`. Section sub-paths are stored as
|
||||
/// `"<path>::<heading>"`.
|
||||
@@ -421,7 +424,7 @@ impl ClawhdfBackend {
|
||||
|
||||
// ── Compaction & Consolidation hooks (7.6) ────────────────────────────
|
||||
|
||||
/// Run a compaction cycle — called by OpenClaw during session compaction.
|
||||
/// Run a compaction cycle (decay, compaction, WAL flush).
|
||||
///
|
||||
/// Sequence:
|
||||
/// 1. `tick_session()` — apply Hebbian decay to all activation weights.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
//!
|
||||
//! Records the origin, authorship, and a content hash of every memory chunk
|
||||
//! so the system can detect *accidental* corruption and trace data lineage.
|
||||
//! The hash is unkeyed (see [`fnv1a_64`]) — this is not a tamper-evidence or
|
||||
//! The hash is unkeyed (FNV-1a) — this is not a tamper-evidence or
|
||||
//! authenticity guarantee.
|
||||
|
||||
use std::collections::HashMap;
|
||||
|
||||
Reference in New Issue
Block a user