Repository navigation
Begin here documentation contract
Generated from essences/begin_here.md. Edit the source; changes made here are overwritten.
Read this before creating or editing a document in this repository.
- Essences contain stable product documents, plus the generated map.jsonl and append-only decisions.jsonl. The stable foundation is the capability map, core essence, vision, and detailed stable contracts.
- prod-docs contains product help available through the CLI docs command group.
- Skills contain the step-by-step procedures agents use to complete operational tasks.
Stable docs describe lasting product behavior and invariants through UI surfaces, CLI command groups, and API areas. They do not narrate implementation mechanics. Implementation code may refer to the relevant essences; essence documents link only to other essence files.
The capability map describes product vectors, capabilities, entry points, invariants, status, and relationships. The core essence describes core parts, clients, and message routing. The vision says why the product capabilities exist. The map is generated from the capability map and core essence; it is a navigation aid, not an architecture blueprint, and the architecture is never reshaped to fit it. The decision journal records why the map changed and is append-only.
Detailed contracts have one authoritative home: memory owns durable knowledge, recall and hygiene; orchestration owns roles, task authority and continuity; permissions separates execution access, operator authority, plugin grants and folder trust; the Supporter Agent owns model judgment and its bounded relationship to deterministic action; Blueprints own recurring-action graphs, their escalation and their improvement; interface conventions own the shared vocabulary of every visible surface.
Edit a stable doc when product behavior, an entry point, or an invariant changes. Update the relevant capability entry and the detailed contract for its area together.
Do not use a stable doc to restate code, narrate a refactor, record a fix, add a temporary example, or tidy wording without a product change.
| Information | Home |
|---|---|
| Implementation detail | The code |
| Step-by-step procedure | A project skill |
| Decisions and incident history | Plan strides and commit messages |
| Transient work | The plan |
Verify the product first, then fix whichever is wrong. A doc edit never papers over a product bug.
- Write in English.
- Keep stable statements precise and avoid duplicating them across documents.
- Product help uses revision markers; stable essence docs do not. Prefer removing stale or duplicated statements over restating them.
- Link from an essence only to another essence file.
- Domios Vision
- Domios capability map
- Domios core
- Orchestration: intent, authority and continuity
- Memory: durable knowledge and recall
- Permissions: who authorizes what
- Supporter Agent: the OS spinal cord
- Blueprints: self-improving action programs
- Interface conventions
- Runtime event path
- Begin here: documentation contract