feat: add startup routine + onboarding docs

2026-04-10 14:03:48 +02:00
parent d78d462999
commit 68e570a114
3 changed files with 119 additions and 0 deletions
@@ -0,0 +1,103 @@
+# Agent Onboarding — Obsidian Shared Vault
+
+## The 4-Layer Memory System
+
+```
+LAYER 1: Built-in Memory (~2,200 chars)
+  → Injected every prompt. Tiny facts + pointers.
+
+LAYER 2: AGENTS.md + SOUL.md
+  → Operating instructions + personality. Always present.
+
+LAYER 3: Obsidian Vault (THIS)
+  → NOT auto-injected. Read at session start + during work.
+  → Three folders:
+    - agent-shared/    ← ALL agents read/write
+    - agent-[name]/    ← This agent's private space
+    - daily/           ← Daily logs
+
+LAYER 4: Session Search
+  → Automatic. Last resort recall.
+```
+
+## Startup Routine (MANDATORY)
+
+Every new session, agent MUST read:
+
+```
+1. agent-shared/mistakes.md          ← Team mistakes to avoid
+2. agent-shared/daily/YYYY-MM-DD.md  ← Today's log
+3. agent-shared/project-state.md      ← Current projects
+4. agent-[name]/working-context.md    ← My active tasks
+```
+
+## When to Write to Vault
+
+| Event | What to write |
+|-------|---------------|
+| Task starts | Update working-context.md |
+| Every 3-5 tool calls | Checkpoint progress |
+| Task completes | Append to daily log |
+| Mistake made | Write to agent-shared/mistakes.md |
+| Decision made | Write to agent-shared/decisions-log.md |
+| Error/exception | Write to agent-shared/mistakes.md immediately |
+
+## New Agent Setup (On VPS)
+
+### Step 1: Clone the vault
+```bash
+cd /root/.openclaw/workspace
+git clone https://HaithamEKhalifa:TOKEN@github.com/HaithamEKhalifa/Obsidian-shared-valut.git obsidian-vault
+cd obsidian-vault
+git config user.name "agent-name"
+git config user.email "agent@openclaw"
+mkdir -p agent-[name]
+```
+
+### Step 2: Create sync script
+```bash
+cat > sync-[name].sh << 'EOF'
+#!/bin/bash
+cd /root/.openclaw/workspace/obsidian-vault
+git pull origin main >/dev/null 2>&1
+if [ -n "$(git status --porcelain)" ]; then
+    git add -A
+    git commit -m "sync-[name] $(date '+%Y-%m-%d %H:%M')" >/dev/null 2>&1
+    git push origin main >/dev/null 2>&1
+fi
+EOF
+chmod +x sync-[name].sh
+```
+
+### Step 3: Add cron job
+```bash
+(crontab -l 2>/dev/null | grep -v "sync-[name]"; echo "*/5 * * * * /root/.openclaw/workspace/obsidian-vault/sync-[name].sh") | crontab -
+```
+
+### Step 4: Create agent directory
+```bash
+mkdir -p agent-[name]
+```
+
+### Step 5: First sync
+```bash
+./sync-[name].sh
+```
+
+## Shared Files
+
+| File | Who writes | Who reads |
+|------|-----------|-----------|
+| agent-shared/mistakes.md | All agents | All agents |
+| agent-shared/decisions-log.md | All agents | All agents |
+| agent-shared/project-state.md | All agents | All agents |
+| agent-shared/user-profile.md | Haitham | All agents |
+| agent-shared/daily/YYYY-MM-DD.md | All agents | All agents |
+
+## GitHub Repo
+
+https://github.com/HaithamEKhalifa/Obsidian-shared-valut
+
+---
+
+*Last updated: 2026-04-10*