This is the map for humans using or extending Brainy. The product Quick Start lives in the root README.
| Doc | What it covers |
|---|---|
| README | What Brainy is, Compose quickstart, API table, benchmark summary |
| api.md | HTTP routes, auth, request bodies |
| conversation-ingest.md | How chat clients should call /ingest |
| benchmarks/README.md | Full benchmarks: published % vs claims, same-pin, harness, reproduce |
| benchmarks/published-claims.md | Sourced LoCoMo / LME / BEAM percents (Mem0, Zep, SuperMemory, Letta, Hindsight) |
| ../evals/README.md | Fixture harnesses; Mem0 Platform runners |
| external-postgres-runbook.md | Run API + worker on your own Postgres |
| Doc | What it covers |
|---|---|
| vertical/verticalization-model.md | Packs vs schemas; primitives |
| packs/marketing/v1/pack.yaml | First vertical pack |
| commercial-beta-checklist.md | Self-host vs hosted-beta gaps |
| Doc | What it covers |
|---|---|
| CONTRIBUTING.md | Setup, tests, PRs against dev |
| SUPPORT.md | Where to ask for help |
| CODE_OF_CONDUCT.md | Community standards |
| SECURITY.md | Vulnerability reporting |
| CITATION.cff | Cite this repository |
| AGENTS.md | Notes for automated coding agents |
Long-form internal notes live under research/. They are not the getting-started path.
cmd/api,cmd/worker— HTTP API and extract workerinternal/— Go packagespacks/— YAML vertical packs (first: marketing)fixtures/— eval goldensevals/— HTTP harnesses against a live API