Skip to content
This repository was archived by the owner on Jan 2, 2026. It is now read-only.

Commit af05124

Browse files
committed
docs: improve accuracy and add debugging guide
README.md: - Add architecture infographic - Fix command syntax to use colon format (/memory:capture) - Add hook configuration environment variables USER_GUIDE.md: - Add comprehensive "Debugging, Discovery & Memory Review" section - Add memory discovery, searching strategies, quality review - Add debugging commands and maintenance tasks - Update Table of Contents - Fix command syntax throughout DEVELOPER_GUIDE.md: - Fix incorrect timeout values to match config.py - Add hooks module to package structure skills/memory-recall/: - Fix incomplete namespace table (all 10 namespaces) - Rewrite namespace-guide.md with complete documentation - Fix search result attribute names in examples
1 parent 26ace94 commit af05124

5 files changed

Lines changed: 724 additions & 137 deletions

File tree

README.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Git-native, semantically-searchable memory storage for Claude Code.
44

5+
<p align="center">
6+
<img src="docs/_assets/infograph-git-notes-memory-project-memory.png" alt="Git Notes Memory Architecture" width="800"/>
7+
</p>
8+
59
<!-- Badges -->
610
[![CI](https://github.com/zircote/git-notes-memory-manager/actions/workflows/ci.yml/badge.svg)](https://github.com/zircote/git-notes-memory-manager/actions/workflows/ci.yml)
711
[![PyPI version](https://img.shields.io/pypi/v/git-notes-memory.svg)](https://pypi.org/project/git-notes-memory/)
@@ -21,7 +25,7 @@ Git-native, semantically-searchable memory storage for Claude Code.
2125
- **Git-native storage**: Memories stored as git notes that sync with push/pull
2226
- **Semantic search**: Find relevant memories via sentence-transformer embeddings
2327
- **10 memory namespaces**: inception, elicitation, research, decisions, progress, blockers, reviews, learnings, retrospective, patterns
24-
- **Progressive hydration**: Load memory content incrementally (SUMMARY FULL FILES)
28+
- **Progressive hydration**: Load memory content incrementally (SUMMARY -> FULL -> FILES)
2529
- **Concurrent-safe**: File locking prevents corruption from parallel captures
2630
- **XDG-compliant**: Standard paths on all platforms
2731

@@ -55,15 +59,15 @@ memories = recall.search("database choice", namespace="decisions", limit=5)
5559

5660
## Claude Code Plugin
5761

58-
When used as a Claude Code plugin, the following commands are available:
62+
When used as a Claude Code plugin, the following slash commands are available:
5963

60-
- `/remember <namespace> <summary>` - Capture a memory
61-
- `/recall <query>` - Search memories semantically
62-
- `/context <spec>` - Load all memories for a spec
63-
- `/memory status` - Show index statistics
64-
- `/memory reindex` - Rebuild the search index
65-
- `/memory verify` - Check index consistency
66-
- `/memory gc` - Garbage collect old memories
64+
| Command | Description |
65+
|---------|-------------|
66+
| `/memory:capture <namespace> <summary>` | Capture a memory |
67+
| `/memory:recall <query>` | Search memories semantically |
68+
| `/memory:search <query>` | Advanced search with filters |
69+
| `/memory:sync [full\|verify\|repair]` | Synchronize or repair the index |
70+
| `/memory:status [--verbose]` | Show index statistics |
6771

6872
### Hooks Integration
6973

@@ -94,13 +98,19 @@ make quality
9498

9599
## Configuration
96100

97-
Environment variables:
101+
Environment variables (see `.env.example` for all options):
98102

99103
| Variable | Description | Default |
100104
|----------|-------------|---------|
101105
| `MEMORY_PLUGIN_DATA_DIR` | Data directory path | `~/.local/share/memory-plugin/` |
102106
| `MEMORY_PLUGIN_GIT_NAMESPACE` | Git notes namespace | `refs/notes/mem` |
103107
| `MEMORY_PLUGIN_EMBEDDING_MODEL` | Embedding model name | `all-MiniLM-L6-v2` |
108+
| `MEMORY_PLUGIN_AUTO_CAPTURE` | Enable auto-capture hook | `false` |
109+
110+
### Hook Configuration
111+
112+
| Variable | Description | Default |
113+
|----------|-------------|---------|
104114
| `HOOK_ENABLED` | Master switch for hooks | `true` |
105115
| `HOOK_SESSION_START_ENABLED` | Enable SessionStart context injection | `true` |
106116
| `HOOK_USER_PROMPT_ENABLED` | Enable signal detection in prompts | `false` |

docs/DEVELOPER_GUIDE.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,18 @@ git_notes_memory/
3636
├── utils.py # Utility functions
3737
├── search.py # SearchOptimizer
3838
├── patterns.py # PatternManager
39-
└── lifecycle.py # LifecycleManager
39+
├── lifecycle.py # LifecycleManager
40+
└── hooks/ # Hook handler modules
41+
├── session_start_handler.py
42+
├── user_prompt_handler.py
43+
├── stop_handler.py
44+
└── services/ # Hook support services
45+
├── context_builder.py
46+
├── project_detector.py
47+
├── signal_detector.py
48+
├── novelty_checker.py
49+
├── capture_decider.py
50+
└── session_analyzer.py
4051
```
4152

4253
---
@@ -598,13 +609,13 @@ from git_notes_memory.config import (
598609
MAX_SUMMARY_CHARS, # 100
599610
MAX_RECALL_LIMIT, # 100
600611

601-
# Timeouts
602-
SEARCH_TIMEOUT_MS, # 5000
603-
CAPTURE_TIMEOUT_MS, # 30000
604-
LOCK_TIMEOUT_SECONDS, # 30
612+
# Timeouts (in milliseconds unless noted)
613+
SEARCH_TIMEOUT_MS, # 500
614+
CAPTURE_TIMEOUT_MS, # 2000
615+
LOCK_TIMEOUT_SECONDS, # 5
605616

606617
# Lifecycle
607-
DECAY_HALF_LIFE_DAYS, # 30.0
618+
DECAY_HALF_LIFE_DAYS, # 30
608619
)
609620
```
610621

0 commit comments

Comments
 (0)