config-atlas/registry/README.md

29 lines
1.2 KiB
Markdown
Raw Normal View History

# Registry
Markdown-first registry for config-atlas. Two entry families:
- **Configuration surfaces** (`surfaces/`) — the atlas's core artifact. Each entry
maps a configuration surface (where it lives, owner, kind, scope, source links),
validated against [`../schemas/surface-entry.schema.json`](../schemas/surface-entry.schema.json).
See [`../docs/configuration-surface-schema.md`](../docs/configuration-surface-schema.md)
for the model and [`../docs/canon-mapping.md`](../docs/canon-mapping.md) for ITC alignment.
Index: `indexes/surfaces.yaml` (ATLAS-WP-0002-T03).
- **Capabilities** (`capabilities/`) — capability index for reuse-surface federation
(below).
Surfaces store the **map only** — never live configuration values, never secret
values.
## Capability Registry
2026-06-26 13:44:08 +00:00
Markdown-first capability index for federation and reuse planning.
## Authoring
1. Copy a capability entry template (see reuse-surface `templates/capability-entry.template.md`).
2. Add the row to `indexes/capabilities.yaml`.
3. Run `reuse-surface validate` from a checkout with the CLI installed.
4. Merge to `main` and verify publish with `reuse-surface establish --publish-check`.
Federation contract: reuse-surface `docs/RegistryFederation.md`.