Skip to content

Commit c1f737c

Browse files
committed
Adrs
1 parent 259eaa4 commit c1f737c

1 file changed

Lines changed: 19 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,24 @@ mise run run:web --instance <instance-name>
4141

4242
Check service status: `npx pm2 status`. Check logs: `tail .build-cache/run/<instance-name>/<service>.log`.
4343

44+
## Architecture decision records (ADRs)
45+
46+
Accepted architecture and product decisions live in [`docs/adrs/`](docs/adrs/). Each file is a numbered ADR (e.g. `0008.webapi-backend-blend-via-config-global.md`) with **Context**, **Decision**, and **Consequences**.
47+
48+
**When working on a task, read any ADR that matches the area you are changing** — especially for configuration, deployment blends, search/CRM indexing, auth, client generation, and cross-cutting conventions. Do not contradict an accepted ADR without updating it or adding a new ADR that supersedes it.
49+
50+
Current topics include (non-exhaustive; browse the directory):
51+
52+
| ADR | Topic |
53+
|-----|--------|
54+
| 0002 | Dev environment and mise tasks |
55+
| 0004 | API and MCP |
56+
| 0005 | Recording events |
57+
| 0006 | Client-side instant search |
58+
| 0007 | Search entity indexing and backfill |
59+
| 0008 | WebAPI backend blend via `Config.global` |
60+
| 0009 | Search index method version |
61+
4462
## Generating code
4563

4664
Whenever some model from the core package is changed, code on the
@@ -63,7 +81,7 @@ mise run add-migration "The name of the migration"
6381
```
6482

6583
This will generate a new file in src/core/migrations/sqlite/versions
66-
and in sqr/core/migrations/postgres/versions,
84+
and in src/core/migrations/postgres/versions,
6785
link it in the sequence of migrations, and you can then edit it
6886
there, based on the patterns established.
6987

0 commit comments

Comments
 (0)