AGENTS.md: add prominent warning to work in source dir, not install targets

This commit is contained in:
Levi Neely 2026-08-03 09:05:21 +02:00
parent 8e2c0a3929
commit a3f44bb565
1 changed files with 10 additions and 1 deletions

View File

@ -1,5 +1,11 @@
# AGENTS.md
Project-level context for AI agents working in this repository.
> **⚠️ IMPORTANT: All work must be done in THIS source directory (`~/src/ollie/`).**
> Never edit files under `~/.config/ollie/` — that is an install target.
> Changes made there are overwritten on the next `just install-data`.
> Edit source files here, then run `just` to build and install.
## Project Overview
Ollie is an AI agent runtime inspired by Plan 9: agent state and behaviors are exposed as files in a 9P namespace. Orchestration, scheduling, and UIs are external — shell scripts, editors, web apps. The core is minimal; capabilities come from composing scripts.
## Repository Layout
@ -28,7 +34,10 @@ ollie/ ← you are here
└── experiments/ Trial notes
```
### Canonical source for prompts/tools/skills
Prompt and tool files live in `data/`. The `just install-data` target copies them to `~/.config/ollie/`. **Do not edit `~/.config/ollie/` directly** — changes are overwritten on next install.
> **⛔ DO NOT edit `~/.config/ollie/` directly — it is an install target. All changes go in this repo.**
Prompt and tool files live in `data/`. The `just install-data` target copies them to `~/.config/ollie/`.
| Location | Purpose | Deployed by |
|----------|---------|-------------|
| `data/prompts/`, `data/tools/` | Canonical source for all prompts, tools, and skills | `just install-data` |