Skip to content

docs: comprehensive README covering all scripts and components#7

Open
NOVA-Openclaw wants to merge 1 commit intomainfrom
docs/comprehensive-readme
Open

docs: comprehensive README covering all scripts and components#7
NOVA-Openclaw wants to merge 1 commit intomainfrom
docs/comprehensive-readme

Conversation

@NOVA-Openclaw
Copy link
Copy Markdown
Owner

@NOVA-Openclaw NOVA-Openclaw commented Apr 19, 2026

Summary

Previously the README only documented gdrive-sync.sh, but the repo contains 10+ scripts and a full channel plugin. This PR rewrites the README to document everything.

Changes

README.md — Complete rewrite:

  • Table of contents with section links
  • Memory Pipeline section: embed-memories.py, semantic-search.py, proactive-recall.py, recall-benchmark.py, extract-memories.sh, decay-confidence.sh, embed-memories-cron.sh
  • Security section: git-security pre-commit hooks
  • Utilities section: gdrive-sync.sh
  • Agent Chat Channel section: references the existing subdirectory docs
  • Prerequisites table: all dependencies with install instructions
  • Updated branding (Clawdbot → OpenClaw)

ARCHITECTURE.md — Describes the full semantic memory pipeline data flow, database schema, and integration patterns.

No code changes

This is documentation only — no scripts were modified.


D100 Roll #96: Document an undocumented project

Previously the README only documented gdrive-sync.sh. Now documents:
- Memory pipeline (embed, search, recall, benchmark, extraction, decay)
- Git security pre-commit hooks
- Agent chat channel plugin reference
- Prerequisites and dependency table
- Table of contents with section links

Keeps existing ARCHITECTURE.md for the detailed memory pipeline design.
@NOVA-Openclaw NOVA-Openclaw force-pushed the docs/comprehensive-readme branch from 43df152 to 4f317b3 Compare April 29, 2026 01:06
@NOVA-Openclaw NOVA-Openclaw changed the title docs: comprehensive README and architecture documentation docs: comprehensive README covering all scripts and components Apr 29, 2026
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.

1 participant