docs: add VitePress documentation site
- 22 content pages across Guide, Concepts, and Reference sections - Custom indigo/cyan theme with Lucide icons and Mermaid diagrams - GitHub Actions workflow for GitHub Pages deployment - Live preview: https://mempalace-docs.netlify.app/
This commit is contained in:
@@ -0,0 +1,85 @@
|
||||
# Configuration
|
||||
|
||||
## Global Config
|
||||
|
||||
Located at `~/.mempalace/config.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"palace_path": "/custom/path/to/palace",
|
||||
"collection_name": "mempalace_drawers",
|
||||
"people_map": {"Kai": "KAI", "Priya": "PRI"}
|
||||
}
|
||||
```
|
||||
|
||||
| Key | Default | Description |
|
||||
|-----|---------|-------------|
|
||||
| `palace_path` | `~/.mempalace/palace` | Where ChromaDB stores your drawers |
|
||||
| `collection_name` | `mempalace_drawers` | ChromaDB collection name |
|
||||
| `people_map` | `{}` | Entity name → AAAK code mappings |
|
||||
|
||||
## Project Config
|
||||
|
||||
Generated by `mempalace init` in your project directory:
|
||||
|
||||
### `mempalace.yaml`
|
||||
|
||||
```yaml
|
||||
wing: myproject
|
||||
rooms:
|
||||
- backend
|
||||
- frontend
|
||||
- decisions
|
||||
palace_path: ~/.mempalace/palace
|
||||
```
|
||||
|
||||
### `entities.json`
|
||||
|
||||
```json
|
||||
{
|
||||
"Kai": "KAI",
|
||||
"Priya": "PRI"
|
||||
}
|
||||
```
|
||||
|
||||
Wings are auto-detected during `mempalace init` from:
|
||||
- Directory names → project wings
|
||||
- Detected people in file content → person wings
|
||||
- Explicit `--wing` flag on mine commands
|
||||
|
||||
## Identity
|
||||
|
||||
Located at `~/.mempalace/identity.txt`. Plain text. Becomes Layer 0 — loaded every session.
|
||||
|
||||
```text
|
||||
I am Atlas, a personal AI assistant for Alice.
|
||||
Traits: warm, direct, remembers everything.
|
||||
People: Alice (creator), Bob (Alice's partner).
|
||||
Project: A journaling app that helps people process emotions.
|
||||
```
|
||||
|
||||
::: tip
|
||||
Write your identity file in first person from the AI's perspective. This becomes the AI's self-concept on wake-up.
|
||||
:::
|
||||
|
||||
## Palace Path Override
|
||||
|
||||
All commands accept `--palace <path>` to override the default location:
|
||||
|
||||
```bash
|
||||
mempalace search "query" --palace /tmp/test-palace
|
||||
mempalace mine ~/data/ --palace /tmp/test-palace
|
||||
```
|
||||
|
||||
The MCP server also accepts `--palace`:
|
||||
|
||||
```bash
|
||||
python -m mempalace.mcp_server --palace /custom/palace
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
| Variable | Description |
|
||||
|----------|-------------|
|
||||
| `MEMPALACE_PALACE_PATH` | Override palace path (same as `--palace`) |
|
||||
| `MEMPAL_DIR` | Directory for auto-mining in hooks |
|
||||
Reference in New Issue
Block a user