Skip to main content

Overview

Documentation Map​

Overview

Tool / Contract Summary​

jhf-bobbin is Helpifyr’s protected-knowledge operator module for OpenClaw memory enablement. It installs, re-applies, verifies, and packages a bounded Mem0 + LocalAI + Qdrant stack, while consuming Fabric-owned governance and claims truth read-only.

Business Value​

  • keeps OpenClaw memory enablement reproducible instead of host-specific guesswork
  • separates runtime tooling from policy/lifecycle ownership
  • gives deployment and QA consumers machine-readable evidence instead of ad-hoc operator notes

Current Verified State​

  • canonical stack truth exists in configs/stack-contract.json
  • runtime, docs, packaging, and contract validators are repo-owned and wired into CI/selfcheck
  • support-summary and Dobby marked-provenance boundaries are contract-backed
  • Fabric governance, combination, JARVIS, and runtime-claims consumption is explicit and validator-backed

Available Now​

  • installer, reapply, rollback, smoke, and drift-detection scripts
  • metadata/status export and package artifact contract surfaces
  • machine-readable feature registry for QA and RC-readiness review

Optional / Extended​

  • optional live host probe evidence
  • optional live Fabric readback checks
  • optional low-CPU runtime profile

Planned / Not in Current Scope​

  • no resident Bobbin API service
  • no Bobbin-owned policy or proposal lifecycle authority
  • no production-host mutation from default CI

Public Surfaces​

  • API and Public Surfaces (docs/API.md)
  • Install
  • Configuration
  • Feature Registry (docs/MODULE_FEATURES.md)
  • Capabilities (docs/CAPABILITIES.md)
  • Integrations (docs/INTEGRATIONS.md)

Contract Families​

Fabric-owned truth is consumed read-only. See:

  • Fabric Tool Profile (docs/FABRIC_TOOL_PROFILE.md)
  • Memory Policy and Claims Consumption (docs/MEMORY_POLICY_AND_CLAIMS_CONSUMPTION.md)

Producer-/Consumer-Zuordnung​

  • Bobbin produces:
    • installer/reapply/verify tooling
    • package metadata
    • repo-local metadata and status exports
    • machine-readable QA feature inventory
  • Bobbin consumes:
    • OpenClaw runtime state
    • LocalAI and Qdrant runtime APIs
    • Fabric governance and claims truth
    • approved support summaries and marked Dobby artifacts

Compatibility Window​

  • version truth: v0.x.y or derived 0.0.0+<shortsha>
  • runtime reference platform: Linux
  • host verification remains operator-run outside baseline CI

Lifecycle Status​

  • module state: active
  • delivery posture: operator kit
  • maturity: RC-readiness preparation, no RC created in this run

Readiness / Drift / Monitoring​

  • repo-local readiness:
    • bash scripts/fabric-selfcheck.sh
    • python3 scripts/check_docs_contract.py
    • python3 scripts/check_module_features_contract.py
  • live/runtime drift:
    • python3 scripts/check_live_runtime_contract.py
    • python3 scripts/export_host_runtime_snapshot.py

Deployment / Verify​

bash scripts/bootstrap.sh
bash scripts/install_jhf_memory.sh
bash scripts/fabric-selfcheck.sh
python3 scripts/check_docs_contract.py
python3 scripts/check_module_features_contract.py

Docs Platform v1.6 Baseline​

The canonical base docs family for this repository is:

  • README.md
  • docs/OVERVIEW.md
  • docs/INSTALL.md
  • docs/CONFIGURATION.md
  • docs/OPERATIONS.md
  • docs/TROUBLESHOOTING.md
  • docs/RELEASE_NOTES.md
  • docs_manifest.yml

These pages provide the repo-owned foundation for docs inventory, capability coverage, rollback readiness, and execution-link posture.

Known Limits​

  • host-specific runtime evidence still depends on operator access
  • community plugin drift remains an upstream compatibility risk
  • some end-to-end producer/consumer tests remain cross-repo by nature
  • JaddaHelpifyr/jhf-bobbin#60
  • JaddaHelpifyr/jhf-bobbin#69
  • JaddaHelpifyr/jhf-bobbin#74

AGPLv3. See ../LICENSE (LICENSE).

Learn more at helpifyr.com.