Commit graph

5 commits

Author SHA1 Message Date
Kent Overstreet
d12c28ebcd docs: expand README getting started section
Walk through install, init, hooks setup, daemon start, and basic
usage so someone new to the project can get going from the README
alone.
2026-03-07 13:58:19 -05:00
Kent Overstreet
9e6cf3b830 docs: finish splitting README into component docs
README is now just an overview with links. Component docs:
- docs/memory.md: store design, algorithms, config, CLI reference
- docs/hooks.md: Claude Code integration setup
- docs/daemon.md, docs/notifications.md: from previous commit
2026-03-07 13:57:55 -05:00
Kent Overstreet
908f8c9e52 docs: split README into component docs, update jobkit dep
- Break README into README.md (overview), docs/daemon.md (pipeline
  stages, diagnostics, common issues), docs/notifications.md
  (notification daemon, IRC/Telegram modules)
- Update jobkit dependency from local path to git URL

Co-Authored-By: ProofOfConcept <poc@bcachefs.org>
2026-03-07 13:56:09 -05:00
Kent Overstreet
308fbe4c28 README: rewrite with design overview, notification system, updated config
Document the hippocampus-inspired design (episodic + associative memory,
background consolidation agents, neuroscience-inspired replay/spectral
algorithms). Add full notification system docs (architecture, urgency
levels, activity-aware thresholds, IRC/Telegram modules). Fix config
format to match reality (JSONL, not TOML). Update instructions.md in
the store with notification commands.

Co-Authored-By: ProofOfConcept <poc@bcachefs.org>
2026-03-05 19:26:50 -05:00
Kent Overstreet
f3492e70a0 move README.md to toplevel
Co-Authored-By: ProofOfConcept <poc@bcachefs.org>
2026-03-05 15:55:59 -05:00
Renamed from doc/README.md (Browse further)