Skip to content

docs(spec): index CompressionEvaluation example #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mdheller merged 1 commit into from
Apr 26, 2026
Merged

docs(spec): index CompressionEvaluation example #63

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This directory contains one conforming JSON example payload for each top-level s

## What the examples show

The examples are designed to tell coherent end-to-end stories. The original example set catalogs, governs, transforms, and releases a personal health dataset within an agent session. Newer SourceOS examples show a SourceOS Workstation artifact flowing from content intent through overlays, build request, release manifest, evidence bundle, catalog entry, and access profile. The control-plane examples add the local-first lifecycle proof path: a `ReleaseSet` assigned to an M2 demo device, a `BootReleaseSet` for the recovery/provisioning lane, an `EnrollmentToken` authorizing one-time recovery access, and a `Fingerprint` reporting the realized post-apply state.
The examples are designed to tell coherent end-to-end stories. The original example set catalogs, governs, transforms, and releases a personal health dataset within an agent session. Newer SourceOS examples show a SourceOS Workstation artifact flowing from content intent through overlays, build request, release manifest, evidence bundle, catalog entry, and access profile. The control-plane examples add the local-first lifecycle proof path: a `ReleaseSet` assigned to an M2 demo device, a `BootReleaseSet` for the recovery/provisioning lane, an `EnrollmentToken` authorizing one-time recovery access, and a `Fingerprint` reporting the realized post-apply state. Compression Commons examples add an artifact-versus-baseline evaluation record that references existing governance, execution, provenance, and content-reference contracts.

```text
connector.json ──► asset.json
Expand Down Expand Up @@ -50,6 +50,8 @@ content_spec.json ──► overlay_bundle.json ──► build_request.json ─
access_profile.json

release_set.json ──► boot_release_set.json ──► enrollment_token.json ──► fingerprint.json

compressionevaluation.json ──► policy_decision.json / run.json / provenance.json / truth_surface.json / delta_surface.json
```

---
Expand All @@ -65,6 +67,16 @@ These examples illustrate the Truth Plane contract additions:

---

## Recent additions — Compression Commons examples

These examples illustrate artifact-versus-baseline evaluation using existing SourceOS/SociOS governance, execution, provenance, and reference contracts.

| File | Schema type | Description |
|------|------------|-------------|
| `compressionevaluation.json` | CompressionEvaluation | Artifact-versus-baseline evaluation composed from ContentRef/DataRef, PolicyDecision, RunRecord, ProvenanceRecord, TruthSurface, and DeltaSurface references |

---

## Recent additions — Control-plane lifecycle and boot provisioning examples

These examples illustrate the local-first control-plane lifecycle and secure boot/recovery family:
Expand Down Expand Up @@ -126,6 +138,7 @@ These examples illustrate the shared object family used by SourceOS artifact bui
| `catalog_entry.json` | CatalogEntry | Catalog entry for the SourceOS Workstation dev release |
| `comment.json` | Comment | A review note on a field mapping |
| `community.json` | Community | The data-governance team community |
| `compressionevaluation.json` | CompressionEvaluation | Artifact-versus-baseline evaluation record |
| `connector.json` | Connector | A local S3 connector |
| `content_ref.json` | ContentRef | Content-addressed reference for fog blobs / manifests |
| `content_spec.json` | ContentSpec | SourceOS Workstation content intent / flavor reference |
Expand Down