ByteBite Docs
ArchitectureADRs

ADR-020: Documentation

Status: Accepted

Kontext

Architektur-, Domain- und Betriebswissen soll versioniert mit dem Projekt gepflegt werden.

Entscheidung

Fumadocs ist die kanonische technische Dokumentation (apps/docs/content/docs).

Produktiv wird die interne Dokumentation über Traefik Basic Auth geschützt.

Konsequenzen

  • ADRs und technische Dokumentation liegen im Repository unter apps/docs.
  • Größere Architekturentscheidungen werden als ADR dokumentiert.
  • Doku wird bei relevanten Änderungen mit aktualisiert.
  • Es gibt keine zweite, parallel gepflegte Dokumentationsquelle.

On this page