Dokumentation pflegen
Alle Sprachen anhand von Nachweisen aus dem aktuellen Produkt aktualisieren.
Die Dokumentation liegt separat unter docs/astroguide. Während einer Dokumentationsänderung bleibt das Anwendungs-Repository projets/AstroGuide die faktische, nur lesbare Quelle.
Quellenpriorität
- tatsächlicher Code, Ansichten, i18n-Katalog und Store;
- aktuelle Compose-Datei, Dockerfile und
nginx.conf; - README,
DEMO.md,CONTRIBUTING.mdundSECURITY.md; - ausführbare Tests;
- Visionsdokumente nur als ausdrücklich benannte Zukunft, niemals als verfügbare Funktion.
Sprachvertrag
Englisch ist kanonisch und voreingestellt. Französisch, Spanisch und Deutsch sind gepflegte Übersetzungen, keine gekürzten Zusammenfassungen. Jede Seite muss in allen vier Sprachen vorliegen, technische Befehle und wissenschaftliche Vorbehalte erhalten und innerhalb derselben Sprache verlinken. Ändert sich eine Tatsache, müssen alle vier Fassungen in derselben Änderung aktualisiert werden.
Prüfungen vor der Auslieferung
npm ci
npm run lint
npm run typecheck
npm run check:content
npm run check:links
npm run buildStarte anschließend die Website und prüfe Suche, Sprachwechsel, sprachkonsistente Navigation, Tastatur, Theme sowie Desktop-, Tablet- und Mobilansichten. Versionsangaben und öffentliche URLs sind bei jeder Veröffentlichung neu zu bestätigen.