Fresh start - excluded large ROM JSON files
This commit is contained in:
88
docs/WORKSPACE_STRUCTURE.md
Normal file
88
docs/WORKSPACE_STRUCTURE.md
Normal file
@@ -0,0 +1,88 @@
|
||||
# Workspace Structure — Quick Reference
|
||||
|
||||
*Updated: 2026-02-18 after hierarchical memory migration*
|
||||
|
||||
---
|
||||
|
||||
## Root Files (Core Config)
|
||||
|
||||
| File | Purpose | Load on Startup? |
|
||||
|------|---------|------------------|
|
||||
| **MEMORY.md** | 🆕 Lightweight index (~2.4k tokens) | ✅ YES |
|
||||
| **IDENTITY.md** | Who I am (name, vibe, emoji) | ✅ YES |
|
||||
| **SOUL.md** | How I behave (principles) | ✅ YES |
|
||||
| **USER.md** | Who you are (Corey) | ✅ YES |
|
||||
| **AGENTS.md** | Agent behavior rules | ✅ YES |
|
||||
| **HEARTBEAT.md** | Periodic tasks | ✅ YES |
|
||||
| **TOOLS.md** | Your specific tool configs | ✅ YES |
|
||||
| **SECURITY.md** | Security rules | ✅ YES |
|
||||
| **workspace-context.md** | Daily temp state | ✅ YES |
|
||||
|
||||
---
|
||||
|
||||
## memory/ Directory (Drill-Down Details)
|
||||
|
||||
```
|
||||
memory/
|
||||
├── people/
|
||||
│ └── corey.md # Your profile, preferences
|
||||
├── projects/
|
||||
│ ├── home-assistant.md # HA, room-assistant, sensors
|
||||
│ ├── coding-workflow.md # Git, repos, LAMP stack
|
||||
│ ├── discord-voice-bot.md # GLaDOS voice bot
|
||||
│ └── memory-system.md # Meta: how memory works
|
||||
├── decisions/
|
||||
│ └── 2026-02.md # February decision log
|
||||
├── context/ # (empty, ready for temp files)
|
||||
└── 2026-*.md # Daily notes (unchanged)
|
||||
```
|
||||
|
||||
**Drill down when:** Conversation mentions project/person/decision
|
||||
|
||||
---
|
||||
|
||||
## Other Key Folders
|
||||
|
||||
| Folder | Contents |
|
||||
|--------|----------|
|
||||
| **.learnings/** | ERRORS.md, LEARNINGS.md, FEATURE_REQUESTS.md |
|
||||
| **unused_files/** | Archived old files (transcripts, duplicates) |
|
||||
| **temp/** | Working scripts, temporary files |
|
||||
| **scripts/** | Helper scripts (backup-memory.py, etc.) |
|
||||
|
||||
---
|
||||
|
||||
## Documentation Files
|
||||
|
||||
| File | What It Documents |
|
||||
|------|-------------------|
|
||||
| MEMORY_MIGRATION_LOG.md | What changed in the rebuild |
|
||||
| MEMORY_SYSTEM_ARCHITECTURE.md | How the full system works |
|
||||
| CRON_REPORT_TEMPLATE.md | Standard format for reports |
|
||||
| FUTURE_WORKER_IDEAS.md | Future agent ideas |
|
||||
| WORKSPACE_STRUCTURE.md | This file — quick reference |
|
||||
|
||||
---
|
||||
|
||||
## Token Load Comparison
|
||||
|
||||
| Scenario | Before | After | Savings |
|
||||
|----------|--------|-------|---------|
|
||||
| Session start | 5-10k tokens | ~2.4k tokens | **60-70%** |
|
||||
| Drill down 1 project | N/A | +~1k tokens | On-demand |
|
||||
| Full context load | 15-20k tokens | ~5-6k tokens | **70%** |
|
||||
|
||||
---
|
||||
|
||||
## Quick Actions
|
||||
|
||||
**Need project details?** → Check `memory/projects/[name].md`
|
||||
**Need user preferences?** → Check `memory/people/corey.md`
|
||||
**Need why we decided X?** → Check `memory/decisions/2026-02.md`
|
||||
**Need what happened today?** → Check `memory/2026-02-18.md`
|
||||
**Need system architecture?** → Check `MEMORY_SYSTEM_ARCHITECTURE.md`
|
||||
|
||||
---
|
||||
|
||||
*System Version: Hierarchical v1.0*
|
||||
*Migration Date: 2026-02-18*
|
||||
Reference in New Issue
Block a user