Zum Inhalt springen

Docs-Sync

Docs-Sync

Wie ADDXION-Dokumentation konsistent gehalten wird.

Mechanismus, damit Plattform-Docs nicht von der Implementierung abdriften.

ecosystem/truths.md (unveränderliche Prinzipien — Truth-SSOT)
↓ referenziert per T-…-ID
addxion-docs (Plattform-Wahrheit, ## Truths + ## Für Agents pro Seite)
↓ verlinkt, dupliziert nicht
Produkt-MASTERPLANs (süper, addxion-ai, addxion-neon)
↓ verweist auf
AGENTS.md (Agent-Regeln + ## Truths pro Repo)
EbeneOrtWas gehört hierher
0 — Truthsecosystem/truths.mdFeste Prinzipien und Wahrheiten (T-…)
1 — Plattformaddxion-docs/src/content/docs/Package-Grenzen, Roadmap, Architektur, Guidance
2 — Produkt*/docs/MASTERPLAN.md, addxion-neon/MASTERPLAN.mdProdukt-Phasen, Feature-Tasks, Consumer-Migration
3 — AgentAGENTS.md pro RepoKurzregeln, 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.

ÄnderungPflicht-Updates
Neues Export, neuer Subpathpackages.md, packages-guide.md, betroffenes Guidance-Doc
Package live / geplant → liveroadmap.md (Status-Spalte), packages.md Status-Tabelle
Consumer-Migration abgeschlossenProdukt-MASTERPLAN + roadmap.md
Architektur-Entscheidungecosystem/index.mdx oder betroffenes Guidance-Doc
PageHeader-Struktur / Cross-App-Syncshell/guidance/page-header.md + beide Consumer-Versionen
ÄnderungPflicht-Updates
Neues Feature, neue PhaseNur Produkt-MASTERPLAN (süper/docs/MASTERPLAN.md etc.)
Ökosystem-relevante ExtraktionZusätzlich roadmap.md + addxion-docs Guidance
ÄnderungPflicht-Updates
Deploy-Routingaddxion-docs/DEPLOYMENT.md, addxion-com/cms/docs/DEPLOYMENT.md
Neue Docs-SeiteFrontmatter, ## Truths, ## Für Agents, optional docs-pages.ts
Neue TruthNur in truths.md, dann IDs auf betroffenen Seiten
  1. Code — Package oder Consumer geändert?
  2. Neue Truth? — Nur in truths.md; IDs auf betroffenen Doc-Seiten und in ensure-doc-sections.mjs
  3. roadmap.md — Status-Zeile auf erledigt / teilweise / offen setzen
  4. packages.md — Status-Tabelle und Grenzen aktuell?
  5. packages-guide.md — Sinn/Enthält/Status pro betroffenem Package?
  6. Produkt-MASTERPLAN — Phasen-Tabelle und „Nächste Schritte“?
  7. AGENTS.md — Kurzverweis und Truth-IDs, falls Package-Status sich ändert?
  8. Buildbun run build in addxion-docs

Wenn nur ein Produkt-Feature betroffen (z. B. Lehrer-Termine in süper): Schritte 2–4 entfallen, nur Produkt-MASTERPLAN.

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.

InhaltNur in
Plattform-Truths (T-…)ecosystem/truths.md
Package-Sinn, Grenzen, Statusaddxion-docs
Lehrer-Feature-Tasks (Termine, Fahrstunden)süper MASTERPLAN
Neon Token-Detailsaddxion-docs /docs/neon/ + addxion-neon MASTERPLAN
Markenstrategie (Positionierung, Story, Archetype)addxion-docs /docs/branding/
Marketing-Seiten-Copyaddxion-com (folgt Branding-SSOT)

Nach jeder Package- oder Ökosystem-Änderung:

  1. addxion-docs/.../ecosystem/packages.md + packages-guide.md prüfen
  2. roadmap.md Status aktualisieren
  3. 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.

Terminal-Fenster
cd addxion-docs
bun run build

Build-Fehler (fehlendes Frontmatter, kaputte Links) vor Merge beheben.

IDWahrheit
T-PLATFORM-SSOTPlattform-Wahrheit nur in addxion-docs
T-DOCS-SYNCDocs im gleichen PR-Zyklus wie Ökosystem-Code
T-DOC-SECTIONSJede Doc-Seite: ## Truths + ## Für Agents
T-TRUTHS-SSOTTruths-Registry — referenzieren, nicht duplizieren

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 build in addxion-docs