Task: Define and implement entity view document type
Table of Contents
This page documents a task in the Commission: currency story. It captures the goal, current status, acceptance, and any notes or results.
Goal
Define and implement a new entity_view document type — a single org file that lists
every artefact of a named entity across all projections and components, with proj:
links to the artefacts and their codegen archetypes. The document makes it easy to
navigate the full set of related files and to spot missing projections. Implement
projects/modeling/currency.org as the first example.
Status
| Field | Value |
|---|---|
| State | DONE |
| Parent story | Commission: currency |
| Now | Nothing. |
| Waiting on | Nothing. |
| Next | Nothing. |
| Last touched | 2026-06-07 |
Acceptance
projects/modeling/currency.orgexists with ID2AB04A53-A90D-45E0-917A-F3B4ED604186and#+type: entity_view.- Document has sections: Codegen models, SQL, C++ Domain, C++ Repository, C++ Service, C++ Generator, C++ Messaging (Protocol / Eventing / Handler), Qt, Other projections, Tests, Related entities.
- Every section has a table with
proj:links to artefacts and their codegen archetypes. - Hand-crafted artefacts are marked explicitly so completeness gaps are visible.
- Missing projections (e.g. domain entity model for currency) are called out inline.
Plan
- Write
projects/modeling/currency.orgusing#+type: entity_viewand sections per projection. Survey the codebase first (Explore agent over 176 currency files). - Mark hand-crafted vs. generated artefacts; note missing projections inline.
- The full entity_view doc-type definition (codegen template, compass scaffold, doc_types
entry) is deferred — captured in this task's
* Notesand to be done separately.
Notes
entity_view doc type (deferred full definition, 2026-06-07)
The first example (currency.org) uses #+type: entity_view loosely — the doc type
is not yet formally registered in doc/meta/document_types.md, has no codegen template,
and compass has no scaffold for it. Deferred as a follow-on task to avoid blocking the
currency entity view from being useful immediately.
The document lives under projects/modeling/ (system-wide entities have no component
prefix). When two entities with the same name appear in different components we can
introduce prefixing at that point.
PRs
| PR | Title |
|---|---|
| #1180 | [codegen,modeling] Commission currency: codegen sync and entity catalogue |
Review
| Comment summary | File | Decision | Notes |
|---|---|---|---|