ores.doc.modeling
Table of Contents
This page is the node for the ores.doc.modeling facet of the codegen
template library, part of the ores.doc technical space. Each archetype
below is documented, and holds its mustache source, in its own
linked page — this page is the facet-level summary and the routing
table to them.
1. Summary
Codegen model-authoring scaffolds: entity_org (the literate codegen entity model — frontmatter plus the section/table skeleton the org_loader parses), field_group, junction, lookup_entity (batch-loaded), service_registry, dataset_overview, profile (named element-scope variability bundle), and feature (canonical per-feature detail page).
2. The ores.doc.modeling facet
Scaffolds for the source-of-truth org files that drive the rest of codegen — these are inputs, not generated outputs, of the entity facets in ores.cpp and ores.sql. Each scaffold matches the section/table shape its own loader parses (Primary key, Columns, Left/Right FK sections for junctions, one section per service for the registry).
3. Mustache incantations
Same identity-escape rendering as the rest of the group. The junction
and lookup-entity scaffolds carry frontmatter flags
({{#has_tenant_id}}-style) mirroring the flags their generated SQL
branches on.
4. Archetypes
| Archetype | Description |
|---|---|
| ores.doc.modeling.dataset | Seeder dataset page: #+dataset_name/version/type and source_methodology metadata for ores.seeder datasets. |
| ores.doc.modeling.entity_org | Literate codegen entity model (the org-migration story's format): frontmatter plus the section/table skeleton the org_loader parses. |
| ores.doc.modeling.field_group | Codegen field-group model (*_field_group.org suffix drives loader dispatch); carries #+brief. |
| ores.doc.modeling.junction | Codegen SQL join-table + C++ counterpart (*_junction.org suffix drives loader dispatch): Left/Right FK sides, Columns, SQL/C++ sections. |
| ores.doc.modeling.lookup_entity | Codegen batch-loaded reference table (*_lookup_entity.org suffix drives loader dispatch): minimal frontmatter, Primary key, Columns, optional Artefact indexes. |
| ores.doc.modeling.service_registry | Codegen service-registry model: catalogue of backend services and fleet processes, each with two independent optional aspects – DB access (psql var, IAM role, DML grant prefixes) and deployment (replicas, enabled, dependencies, execution runtime, extra CLI args). One top-level section per service. |
5. Scaffolds outside the inventory
Two of this group's scaffolds predate the ores.* address convention, so
their documents are named for the template they hold and carry
#+type: knowledge rather than #+type: archetype. The inventory generator
reads only ores.* pages, so it cannot list them and the table above omits
them. The documents are:
| Template | Document | Description |
|---|---|---|
doc_profile.org.mustache |
doc_profile_org | Named element-scope MASD profile (variability_<slug>.org): fixed variability-axis assignment table, anchored to a reference entity. |
doc_feature.org.mustache |
doc_feature_org | Canonical detail page for one MASD feature (variability_feature_<slug>.org): identity, effect, structural consequence, used-by profiles. |
6. See also
- ores.doc — the parent technical space's generated facet/archetype catalogue and shared Mustache conventions.
- Other Technical Spaces § "Doc Technical Space" — the domain-concept overview of this technical space.
- Codegen template library — the groups overview.