Skip to content

spec hygiene: canonicalize Truth Plane ADR + examples + schema IDs#35

Merged
mdheller merged 13 commits intomainfrom
spec/hygiene-adr-catalog-20260418
Apr 18, 2026
Merged

spec hygiene: canonicalize Truth Plane ADR + examples + schema IDs#35
mdheller merged 13 commits intomainfrom
spec/hygiene-adr-catalog-20260418

Conversation

@mdheller
Copy link
Copy Markdown
Contributor

This PR cleans up Truth Plane spec authority and reduces ambiguity.

Key changes (no loss of intent):

  1. Canonical ADR
  • Adds ADR-0009 (TruthSurface/DeltaSurface) and Appendix A as the canonical reuse map.
  • Deprecates the colliding ADR-0001 TruthSurface/DeltaSurface files by turning them into stubs pointing to ADR-0009.
  1. Canonical examples
  • Adds snake_case canonical examples: examples/truth_surface.json and examples/delta_surface.json.
  • Removes duplicate hyphenated sample files: truth-surface.sample.json and delta-surface.sample.json.
  1. Catalog/docs hygiene
  • Updates schemas/README.md to include TruthSurface and DeltaSurface in the quick reference and in the Execution/Provenance family table.
  • Updates examples/README.md to include a Truth Plane examples section and add the new files to the file index.
  • Adds docs/adr/README.md as an ADR index + numbering rule.
  1. Schema ID normalization
  • Normalizes control-plane IncidentEvent schema $id into the srcos namespace.

Notes:

  • OpenAPI/AsyncAPI truth-plane patch fragments remain additive as-is.
  • Enforcement remains in SociOS-Linux/SourceOS.

@mdheller mdheller merged commit 258139e into main Apr 18, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant