Domain docs

These notes are for calab-ai/calab-mocks. Read them before changing the fakes estate so issue titles, refactors, and tests use this repo's words.

Files to open

File What it is for In this repo today
CONTEXT.md at the repo root The glossary. When you name a domain concept in an issue title, a refactor proposal, a hypothesis, or a test name, use the term as defined there. Not in the repo yet. /domain-modeling creates it when a term is actually resolved. Format: CONTEXT-FORMAT.md.
CONTEXT-MAP.md at the repo root Points at one CONTEXT.md per context. Use it only when the repo has more than one context. Do not add one. This repository is a single context, so a map would have nothing to list.
docs/adr/ A decision that is hard to reverse, surprising without the context, and the result of a real trade-off. No ADRs yet. /domain-modeling adds docs/adr/NNNN-slug.md when one is warranted. How to write one: ADR-FORMAT.md. One paragraph is enough. Do not create the folder until there is a decision to record.

Until CONTEXT.md exists, use the terms already in this repo: fake host, personality (for example QDox), fixture, SQL estate, landing zone, core RG.

Also read the estate docs that already exist:

File structure

This is a single-context repository:

/
β”œβ”€β”€ CONTEXT.md                 ← glossary, written when the first term is resolved
β”œβ”€β”€ AGENTS.md
β”œβ”€β”€ docs/
β”‚   β”œβ”€β”€ index.md
β”‚   β”œβ”€β”€ azure-deployment.md
β”‚   β”œβ”€β”€ site/docs-site.md
β”‚   β”œβ”€β”€ projects/sair/edw-schema.md
β”‚   β”œβ”€β”€ entra-auth.md
β”‚   β”œβ”€β”€ linear-work-items.md
β”‚   β”œβ”€β”€ triage-labels.md
β”‚   β”œβ”€β”€ agents/
β”‚   └── adr/                   ← written when the first ADR is warranted
β”œβ”€β”€ fake-host/
└── sql-estate/

A consumer exists

A consumer of this estate exists in calab-ai/neuralops-accelerator. That repository creates the connection wiring. How the consumer is wired must not shape the mock. The mock has to speak the external system's protocol. The fact that a consumer calls it is enough.

Flag ADR conflicts

If your output contradicts an ADR under docs/adr/, say so and why reopening it is worth it. There are no ADRs in this repo yet, so this applies once that folder has files.