docs: update metadata and descriptions across multiple documentation files
This commit is contained in:
@@ -1,4 +1,9 @@
|
|||||||
# Architecture Evolution: The Journey from v3 to v5
|
---
|
||||||
|
title: "Architecture Evolution"
|
||||||
|
description: "How claude-mem evolved from v3 to v5+"
|
||||||
|
---
|
||||||
|
|
||||||
|
# Architecture Evolution
|
||||||
|
|
||||||
## The Problem We Solved
|
## The Problem We Solved
|
||||||
|
|
||||||
|
|||||||
@@ -9,9 +9,9 @@ Claude-Mem uses SQLite 3 with the bun:sqlite native module for persistent storag
|
|||||||
|
|
||||||
## Database Location
|
## Database Location
|
||||||
|
|
||||||
- **Current**: `~/.claude-mem/claude-mem.db`
|
**Path**: `~/.claude-mem/claude-mem.db`
|
||||||
|
|
||||||
**Note**: Despite the README claiming v4.0.0+ moved the database to `${CLAUDE_PLUGIN_ROOT}/data/`, the actual implementation still uses `~/.claude-mem/`.
|
The database uses SQLite's WAL (Write-Ahead Logging) mode for concurrent reads/writes.
|
||||||
|
|
||||||
## Database Implementation
|
## Database Implementation
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,9 @@
|
|||||||
# Context Engineering for AI Agents: Best Practices Cheat Sheet
|
---
|
||||||
|
title: "Context Engineering"
|
||||||
|
description: "Best practices for curating optimal token sets for AI agents"
|
||||||
|
---
|
||||||
|
|
||||||
|
# Context Engineering for AI Agents
|
||||||
|
|
||||||
## Core Principle
|
## Core Principle
|
||||||
**Find the smallest possible set of high-signal tokens that maximize the likelihood of your desired outcome.**
|
**Find the smallest possible set of high-signal tokens that maximize the likelihood of your desired outcome.**
|
||||||
|
|||||||
@@ -69,12 +69,14 @@ cat plugin/hooks/hooks.json
|
|||||||
|
|
||||||
#### 3. Data Directory Location
|
#### 3. Data Directory Location
|
||||||
|
|
||||||
v4.0.0+ stores data in `${CLAUDE_PLUGIN_ROOT}/data/`:
|
Data is stored in `~/.claude-mem/`:
|
||||||
- Database: `${CLAUDE_PLUGIN_ROOT}/data/claude-mem.db`
|
- Database: `~/.claude-mem/claude-mem.db`
|
||||||
- Worker port file: `${CLAUDE_PLUGIN_ROOT}/data/worker.port`
|
- PID file: `~/.claude-mem/.worker.pid`
|
||||||
- Logs: `${CLAUDE_PLUGIN_ROOT}/data/logs/`
|
- Port file: `~/.claude-mem/.worker.port`
|
||||||
|
- Logs: `~/.claude-mem/logs/worker-YYYY-MM-DD.log`
|
||||||
|
- Settings: `~/.claude-mem/settings.json`
|
||||||
|
|
||||||
For development/testing, you can override:
|
Override with environment variable:
|
||||||
```bash
|
```bash
|
||||||
export CLAUDE_MEM_DATA_DIR=/custom/path
|
export CLAUDE_MEM_DATA_DIR=/custom/path
|
||||||
```
|
```
|
||||||
@@ -91,19 +93,17 @@ npm run worker:logs
|
|||||||
npm run test:context
|
npm run test:context
|
||||||
```
|
```
|
||||||
|
|
||||||
## Upgrading from v3.x
|
## Upgrading
|
||||||
|
|
||||||
**BREAKING CHANGES - Please Read:**
|
Upgrades are automatic when updating via the plugin marketplace. Key changes in recent versions:
|
||||||
|
|
||||||
v4.0.0 introduces breaking changes:
|
**v7.1.0**: PM2 replaced with native Bun process management. Migration is automatic on first hook trigger.
|
||||||
|
|
||||||
- **Data Location Changed**: Database moved from `~/.claude-mem/` to `${CLAUDE_PLUGIN_ROOT}/data/` (inside plugin directory)
|
**v7.0.0+**: 11 configuration settings, dual-tag privacy system.
|
||||||
- **Fresh Start Required**: No automatic migration from v3.x. You must start with a clean database
|
|
||||||
- **Worker Auto-Starts**: Worker service now starts automatically - no manual `npm run worker:start` needed
|
|
||||||
- **MCP Search Server**: 7 new search tools with full-text search and citations
|
|
||||||
- **Enhanced Architecture**: Improved plugin integration and data organization
|
|
||||||
|
|
||||||
See [CHANGELOG](https://github.com/thedotmack/claude-mem/blob/main/CHANGELOG.md) for complete details.
|
**v5.4.0+**: Skill-based search replaces MCP tools, saving ~2,250 tokens per session.
|
||||||
|
|
||||||
|
See [CHANGELOG](https://github.com/thedotmack/claude-mem/blob/main/CHANGELOG.md) for complete version history.
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
|
|||||||
@@ -74,21 +74,20 @@ See [Architecture Overview](architecture/overview) for details.
|
|||||||
|
|
||||||
## What's New
|
## What's New
|
||||||
|
|
||||||
**v6.4.9 - Context Configuration Settings:**
|
**v7.1.0 - Bun Migration:**
|
||||||
- 11 new settings for fine-grained control over context injection
|
- Replaced PM2 with native Bun process management
|
||||||
- Configure token economics display, observation filtering by type/concept
|
- Switched from better-sqlite3 to bun:sqlite for faster database access
|
||||||
|
- Automatic one-time migration on first hook trigger
|
||||||
|
- Simplified cross-platform support
|
||||||
|
|
||||||
**v6.4.0 - Dual-Tag Privacy System:**
|
**v7.0.0 - Context Configuration:**
|
||||||
- `<private>` tags for user-controlled privacy - wrap sensitive content to exclude from storage
|
- 11 settings for fine-grained control over context injection
|
||||||
- Edge processing ensures private content never reaches database
|
- Dual-tag privacy system (`<private>` tags)
|
||||||
|
|
||||||
**v6.3.0 - Version Channel:**
|
|
||||||
- Switch between stable and beta versions from the web viewer UI
|
|
||||||
|
|
||||||
**Previous Highlights:**
|
**Previous Highlights:**
|
||||||
- **v6.0.0**: Major session management & transcript processing improvements
|
- **v5.5.0**: mem-search skill with 100% effectiveness rate
|
||||||
- **v5.5.0**: mem-search skill enhancement with 100% effectiveness rate
|
- **v5.4.0**: Skill-based search (~2,250 tokens saved per session)
|
||||||
- **v5.4.0**: Skill-based search architecture (~2,250 tokens saved per session)
|
- **v5.1.0**: Web viewer UI at http://localhost:37777
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: "Private Tags"
|
title: "Private Tags"
|
||||||
description: "Control what gets stored in memory with <private> tags"
|
description: "Control what gets stored in memory with privacy tags"
|
||||||
---
|
---
|
||||||
|
|
||||||
# Private Tags
|
# Private Tags
|
||||||
|
|||||||
Reference in New Issue
Block a user