1.3 KiB
Domain Docs
How to consume this repo's domain documentation when exploring the codebase.
Before exploring, read these
CONTEXT.mdat the repo root - the domain glossary and orientation..agents/adr/- read the Architecture Decision Records that touch the area you're about to work in.
If any of these files don't exist, proceed silently. Don't flag their absence or suggest creating them upfront; they are created lazily when terms or decisions actually get resolved.
File structure
/
├── CONTEXT.md
├── .agents/
│ ├── adr/
│ │ ├── 0001-<decision-slug>.md
│ │ └── 0002-<decision-slug>.md
│ ├── docs/
│ └── skills/
└── src/
Use the glossary's vocabulary
When your output names a domain concept (an issue title, a refactor proposal, a hypothesis, a test name), use the term as defined in CONTEXT.md. Don't drift to synonyms the glossary avoids.
If the concept you need isn't in the glossary yet, that's a signal - either you're inventing language the project doesn't use (reconsider), or there's a real gap (note it).
Flag ADR conflicts
If your output contradicts an existing ADR, surface it explicitly rather than silently overriding:
Contradicts ADR-0001 (...) - but worth reopening because...