Docs-Sync
Mechanismus, damit Plattform-Docs nicht von der Implementierung abdriften.
SSOT-Hierarchie
Abschnitt betitelt „SSOT-Hierarchie“ecosystem/truths.md (unveränderliche Prinzipien — Truth-SSOT) ↓ referenziert per T-…-IDaddxion-docs (Plattform-Wahrheit, ## Truths + ## Für Agents pro Seite) ↓ verlinkt, dupliziert nichtProdukt-MASTERPLANs (süper, addxion-ai, addxion-neon) ↓ verweist aufAGENTS.md (Agent-Regeln + ## Truths pro Repo)| Ebene | Ort | Was gehört hierher |
|---|---|---|
| 0 — Truths | ecosystem/truths.md | Feste Prinzipien und Wahrheiten (T-…) |
| 1 — Plattform | addxion-docs/src/content/docs/ | Package-Grenzen, Roadmap, Architektur, Guidance |
| 2 — Produkt | */docs/MASTERPLAN.md, addxion-neon/MASTERPLAN.md | Produkt-Phasen, Feature-Tasks, Consumer-Migration |
| 3 — Agent | AGENTS.md pro Repo | Kurzregeln, Truth-IDs, Verweise auf Ebene 0–2 |
Regel: Package-Wahrheit (Sinn, Grenzen, Status) lebt nur in addxion-docs. Produkt-MASTERPLANs verlinken dorthin — sie duplizieren keine Package-Tabellen.
Truths-SSOT: Unveränderliche Prinzipien in Truths. Ökosystem-Prinzip T-MAINTAIN: Einmal pflegen.
Wann was aktualisieren
Abschnitt betitelt „Wann was aktualisieren“Bei Package-Änderung (Code)
Abschnitt betitelt „Bei Package-Änderung (Code)“| Änderung | Pflicht-Updates |
|---|---|
| Neues Export, neuer Subpath | packages.md, packages-guide.md, betroffenes Guidance-Doc |
| Package live / geplant → live | roadmap.md (Status-Spalte), packages.md Status-Tabelle |
| Consumer-Migration abgeschlossen | Produkt-MASTERPLAN + roadmap.md |
| Architektur-Entscheidung | ecosystem/index.mdx oder betroffenes Guidance-Doc |
| PageHeader-Struktur / Cross-App-Sync | shell/guidance/page-header.md + beide Consumer-Versionen |
Bei Produkt-Feature (nur ein Repo betroffen)
Abschnitt betitelt „Bei Produkt-Feature (nur ein Repo betroffen)“| Änderung | Pflicht-Updates |
|---|---|
| Neues Feature, neue Phase | Nur Produkt-MASTERPLAN (süper/docs/MASTERPLAN.md etc.) |
| Ökosystem-relevante Extraktion | Zusätzlich roadmap.md + addxion-docs Guidance |
Bei Docs-Infrastruktur
Abschnitt betitelt „Bei Docs-Infrastruktur“| Änderung | Pflicht-Updates |
|---|---|
| Deploy-Routing | addxion-docs/DEPLOYMENT.md, addxion-com/cms/docs/DEPLOYMENT.md |
| Neue Docs-Seite | Frontmatter, ## Truths, ## Für Agents, optional docs-pages.ts |
| Neue Truth | Nur in truths.md, dann IDs auf betroffenen Seiten |
Checkliste pro PR (Ökosystem-Änderung)
Abschnitt betitelt „Checkliste pro PR (Ökosystem-Änderung)“- Code — Package oder Consumer geändert?
- Neue Truth? — Nur in truths.md; IDs auf betroffenen Doc-Seiten und in
ensure-doc-sections.mjs - roadmap.md — Status-Zeile auf
erledigt/teilweise/offensetzen - packages.md — Status-Tabelle und Grenzen aktuell?
- packages-guide.md — Sinn/Enthält/Status pro betroffenem Package?
- Produkt-MASTERPLAN — Phasen-Tabelle und „Nächste Schritte“?
- AGENTS.md — Kurzverweis und Truth-IDs, falls Package-Status sich ändert?
- Build —
bun run buildin addxion-docs
Wenn nur ein Produkt-Feature betroffen (z. B. Lehrer-Termine in süper): Schritte 2–4 entfallen, nur Produkt-MASTERPLAN.
Roadmap als Living Status Board
Abschnitt betitelt „Roadmap als Living Status Board“roadmap.md ist die zentrale Status-Tafel des Ökosystems. Idealerweise im gleichen PR wie der Code-Change aktualisieren.
- Phase erledigt → Status
erledigt - Teilweise (z. B. Palette ohne xi-federation) → Status
teilweise+ Kurzkommentar - Langfristig / optional → explizit markieren
Am Ende der Roadmap: Abschnitt Noch offen als kompakte Übersicht.
Was nicht duplizieren
Abschnitt betitelt „Was nicht duplizieren“| Inhalt | Nur in |
|---|---|
Plattform-Truths (T-…) | ecosystem/truths.md |
| Package-Sinn, Grenzen, Status | addxion-docs |
| Lehrer-Feature-Tasks (Termine, Fahrstunden) | süper MASTERPLAN |
| Neon Token-Details | addxion-docs /docs/neon/ + addxion-neon MASTERPLAN |
| Markenstrategie (Positionierung, Story, Archetype) | addxion-docs /docs/branding/ |
| Marketing-Seiten-Copy | addxion-com (folgt Branding-SSOT) |
Agent-Regel (optional in AGENTS.md)
Abschnitt betitelt „Agent-Regel (optional in AGENTS.md)“Nach jeder Package- oder Ökosystem-Änderung:
addxion-docs/.../ecosystem/packages.md+packages-guide.mdprüfenroadmap.mdStatus aktualisieren- Betroffenen Produkt-MASTERPLAN synchronisieren
Diese Regel steht in addxion-docs/AGENTS.md und kann in Consumer-Repos (addxion-ai/AGENTS.md, süper/AGENTS.md) als Verweis stehen.
Verifikation
Abschnitt betitelt „Verifikation“cd addxion-docsbun run buildBuild-Fehler (fehlendes Frontmatter, kaputte Links) vor Merge beheben.
| ID | Wahrheit |
|---|---|
| T-PLATFORM-SSOT | Plattform-Wahrheit nur in addxion-docs |
| T-DOCS-SYNC | Docs im gleichen PR-Zyklus wie Ökosystem-Code |
| T-DOC-SECTIONS | Jede Doc-Seite: ## Truths + ## Für Agents |
| T-TRUTHS-SSOT | Truths-Registry — referenzieren, nicht duplizieren |
Für Agents
Abschnitt betitelt „Für Agents“Scope: Wann welche Docs bei Code- oder Package-Änderungen aktualisiert werden.
- Package-Wahrheit nur in addxion-docs, nicht in Produkt-MASTERPLANs duplizieren
- Ökosystem-PR: packages.md, packages-guide.md, roadmap.md prüfen
- Vor Merge:
bun run buildin addxion-docs