Skip to content

Commit dc06e29

Browse files
committed
Add architecture and invariants documentation sections
Created new documentation files for the architecture and invariants, detailing the identity, API, build, streaming, and data lineage components, as well as breaking-change rules and compatibility policies. This enhances the overall clarity and structure of the documentation.
1 parent 733d2ff commit dc06e29

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

docs/architecture/index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Architecture
3+
description: Identity, API, build, streaming, data lineage
4+
---
5+
6+
# Architecture
7+
8+
| Document | Description |
9+
|----------|-------------|
10+
| [Identity Layer](identity-layer) | Edition identity, fingerprinting, invariants |
11+
| [API Layer](api-layer) | Streaming endpoint, playback prediction, prewarm |
12+
| [Build Layer](build-layer) | Artifact production, concurrency, determinism |
13+
| [Streaming Model](streaming-model) | Playback philosophy, device capability |
14+
| [Data Lineage](data-lineage) | Data flow, entity relationships |
15+
| [Data Contracts](data-contracts) | Fingerprint invariants, data domains |

docs/invariants/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Invariants
3+
description: Breaking-change rules, compatibility policy
4+
---
5+
6+
# Invariants & Governance
7+
8+
| Document | Description |
9+
|----------|-------------|
10+
| [Breaking Changes](breaking-changes) | Version bump, migration, coordination |
11+
| [Compatibility Policy](compatibility-policy) | Identity, API, playback compatibility |

0 commit comments

Comments
 (0)