diff --git a/catalog/catalog.yaml b/catalog/catalog.yaml index dbc13687f4a..7b36d8528f7 100644 --- a/catalog/catalog.yaml +++ b/catalog/catalog.yaml @@ -13,6 +13,10 @@ # equality (the graduated device-class roster), same as roles. # - capabilities, methods, models have no global code seed; this file is # their consolidated source, guarded by the round-trip test. +# - a note's cited beamlines (e.g. "graduated across Diamond i22, i03, i11") +# are not reproduced here; only 2-BM has a descriptor in this repo. Their +# device data is checkable on demand in the private xmap/research (draft) +# and xmap/descriptors (promoted) repos. # # An affordance is a Family property: it declares what the device CAN DO at the # physics layer. A Role declares required_affordances (the contract), and a diff --git a/docs/catalog/index.md b/docs/catalog/index.md index 42dce8a59a3..fb8c85f9869 100644 --- a/docs/catalog/index.md +++ b/docs/catalog/index.md @@ -46,3 +46,5 @@ Some apparent new families are settings axes, not family axes. A high-framerate ## Source of truth Roles and the closed affordance / executor-shape vocabularies are code-defined and validated against the code by drift-guard tests. Families, Capabilities, Methods, and Models are authored in `catalog.yaml`, which supersedes the scenario fixtures as the consolidated source. Until the seeder inversion lands, the code seeds remain authoritative for what CORA actually registers; `catalog.yaml` is the docs projection, kept honest by the round-trip and roles drift-guard tests. + +A graduation note (a Family or Role reaching the rule-of-three, "graduated across Diamond i22, i03, i11") cites the real beamlines that justified it, but does not reproduce their device data here: only CORA's one live deployment, 2-BM, has a descriptor in this repo. The beamlines a graduation note names are modeled from public source, checkable on demand, in the private `xmap/research` (draft surveys and candidates) and `xmap/descriptors` (self-validated, promoted) repos.