Documentation template group
Table of Contents
This page documents the doc group of the codegen template
library — the namespace that gathers related facets. Each facet is a
literate org document in this directory whose mustache blocks tangle
to the .mustache artefacts consumed by generator.py; this page
explains what the group's facets have in common and indexes them.
Summary
Org-mode document scaffolds — the machinery behind compass add.
A single facet owns all twenty doc_* templates, one per document
type in doc_generate.py's TYPE_TO_TEMPLATE map. Unusually for
this library the renderer escapes nothing
(pystache.Renderer(escape=identity)), and outputs are org files
whose own structure must round-trip the literate escaping — see the
facet doc's incantations section.
Facets
The table below is generated — run
projects/ores.codegen/scripts/regenerate_facet_inventories.py after
adding or changing facet docs; do not edit it by hand.
| Facet | Templates | Description |
|---|---|---|
| Documentation templates | 0 | Org-mode document scaffolds behind compass add / doc_generate: agile artefacts (task, story, sprint, version), knowledge docs, recipes, runbooks, skills, captures, memories, codegen models (entity_org, field_group, table, junction, lookup_entity, service_registry), and the facet/facet_group types of this very library. |
Shared conventions
- Every scaffold opens with the
:PROPERTIES:/:ID:drawer and the#+title/#+description/#+type/#+level/#+filetags/#+created/#+updatedfrontmatter contract. - Stateful types render
#+todo:vocabularies and a* Statustable at the type's default state. - Composition types receive
parent_id/parent_titlefor the glossary-linked blurb.
See also
- Codegen template library — the groups overview.
- MASD — the methodology these templates instantiate.
- Applied MASD — the facet catalogue and codegen routes.
- facet_catalogue.org — profile → template/output mapping.