Dokumentationsarchitektur
Das Dokumentationssystem ist als eigenständiges @nextsaasai/docs-Paket aufgebaut und nutzt Markdoc für die Inhaltserstellung. Markdoc wurde für die Dokumentation gegenüber MDX bevorzugt, weil es eine strenge Schema-Validierung für benutzerdefinierte Komponenten bietet und Content-Dateien frei von ausführbarem Code hält. Die Dokumentationsseiten werden auf der Marketing-Website gehostet, dokumentieren aber das Boilerplate-Produkt — du erreichst sie unter /docs neben den Marketing-Seiten.
Inhaltsabdeckung
Jedes wichtige Feature des Boilerplates hat einen entsprechenden Dokumentationsbereich: Authentifizierungs-Setup und -Konfiguration, Payment-Integration mit Lemon Squeezy, AI-Provider-Konfiguration, Security Hardening, Datenbankschema-Verwaltung und Deployment-Workflows. API-Referenzen werden automatisch aus dem Codebase generiert, um mit der Implementierung synchron zu bleiben.
Benutzerdefinierte Markdoc-Komponenten übernehmen wiederkehrende Dokumentationsmuster — Callouts für Warnungen und Tipps, Tab-Bereiche für Anleitungen in verschiedenen Umgebungen und Code-Gruppen zum Anzeigen verwandter Dateien nebeneinander. Diese Komponenten werden als React-Elemente gerendert, aber in reiner Markdoc-Syntax verfasst, sodass die Inhalte auch für Nicht-Entwickler zugänglich bleiben.
Contributors
Sascha Rahn