Skip to content

Commit 72b56d2

Browse files
docs: add INSTRUCTION.md — canonical LLM onboarding guide
Primary onboarding doc for any connected agent: what AgentDrive is, why/how to use it, session workflow, user-facing explanations, and golden rules. Mintlify mirror + README/docs cross-links.
1 parent 9eb0b01 commit 72b56d2

7 files changed

Lines changed: 795 additions & 8 deletions

File tree

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@ All notable changes to this project are documented here. The product is
66

77
## Unreleased
88

9+
### Added — INSTRUCTION.md for LLM onboarding (2026-06-18)
10+
11+
- **`INSTRUCTION.md`** (repo root) — canonical onboarding for any AI agent: what AgentDrive is, why to use it, how it works (capability funnel + 6-step loop), session workflow, anti-patterns, how to explain AgentDrive to the user (elevator pitch, analogies, FAQ), golden rules, and a full session example.
12+
- **`docs/INSTRUCTION.md`** — Mintlify mirror with frontmatter for docs site nav.
13+
- **`README.md`** — points models to INSTRUCTION.md before FOR_AI_MODELS.md.
14+
- **`docs/FOR_AI_MODELS.md`** · **`docs/ai-models/quickstart.md`** — cross-links to INSTRUCTION as entry point.
15+
- **`docs/docs.json`** — INSTRUCTION added to "Using with AI Models" nav; fixed trailing comma in redirects.
16+
917
### Fixed — Repo-wide consistency audit (2026-06-18)
1018

1119
- **Drive path unification (P0)** — removed duplicate `SwarmDriveManager` from `drive.py`; `get_default_drive()` and `create_scoped_pool()` now use `swarm_manager.get_or_create_pool()` → shared `swarms/<id>/drive/` (aligns MCP, memory bank, Experience Graph).

INSTRUCTION.md

Lines changed: 385 additions & 0 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
AgentDrive gives any capable model — Grok, Claude, Cursor, Continue, Ollama, custom harnesses — a **structural memory system** that grows from its own decisions. Not a vector store. Not a chat-memory SaaS. A living substrate where reasoning traces, patterns, skills, and knowledge compound across sessions instead of resetting every time you open a new chat.
1010

11-
> **For AI models:** Your first MCP action is always `agentdrive_mcp_catalog()`. Then read **[docs/FOR_AI_MODELS.md](docs/FOR_AI_MODELS.md)**the canonical rules for working inside AgentDrive.
11+
> **For AI models:** Your first MCP action is always `agentdrive_mcp_catalog()`. Then read **[INSTRUCTION.md](INSTRUCTION.md)**what AgentDrive is, how to use it, and how to explain it to your user. Deep reference: **[docs/FOR_AI_MODELS.md](docs/FOR_AI_MODELS.md)**.
1212
1313
---
1414

@@ -199,7 +199,8 @@ Guides: [docs/AD_GRID_JOIN.md](docs/AD_GRID_JOIN.md) · [docs/AD_GRID_VISION.md]
199199

200200
| Doc | Purpose |
201201
|-----|---------|
202-
| [FOR_AI_MODELS.md](docs/FOR_AI_MODELS.md) | Canonical rules for any connected model |
202+
| [INSTRUCTION.md](INSTRUCTION.md) | **Start here (LLMs)** — what, why, how, explain to user |
203+
| [FOR_AI_MODELS.md](docs/FOR_AI_MODELS.md) | Deep reference rules for any connected model |
203204
| [CAPABILITY_FUNNEL.md](docs/CAPABILITY_FUNNEL.md) | How intelligence compounds (single mental model) |
204205
| [MEMORY_BANK.md](docs/MEMORY_BANK.md) | Deep memory layer — vault/topic, search, anchor |
205206
| [MULTIVERSE_COGNITION.md](docs/MULTIVERSE_COGNITION.md) | Parallel timeline decisions |

docs/FOR_AI_MODELS.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# AgentDrive for AI Models (LLM Onboarding Guide)
22

3-
**This is the canonical "rules for the AI" document.**\
4-
Give this file (or keep it in context) to any model — frontier (Grok, Claude, Cursor) or local (via Continue, Ollama, LM Studio, direct MCP, etc.) — that will use AgentDrive.
3+
**Start with [INSTRUCTION.md](../INSTRUCTION.md)** — what AgentDrive is, why to use it, how it works, session workflow, and how to explain it to your user.
54

6-
Read this once at the start of any serious session. It will make you far more effective.
5+
**This document is the deep reference** — extended rules, Experience Graph tool tables, AD-Grid inhabitant guide, and anti-patterns. Give both files (or keep them in context) to any model — frontier (Grok, Claude, Cursor) or local (via Continue, Ollama, LM Studio, direct MCP, etc.) — that will use AgentDrive.
6+
7+
Read INSTRUCTION.md once at session start; consult this file when you need detail on a specific surface.
78

89
---
910

0 commit comments

Comments
 (0)