Diese Dokumentation pflegen¶
Es gibt drei Guidedog-Projekte: docs/manual, docs/api und docs/gds. Handbuch und GDS wurden mit guidedog quickstart angelegt. Bearbeiten Sie deren erzeugte Vorlagen direkt. Designaufzeichnungen gehören nicht ins Inhaltsverzeichnis des Handbuchs.
Das Handbuch bauen¶
Im Stammverzeichnis des Repositorys:
build/guidedog build html docs/manual -j auto -W
build/guidedog build pdf docs/manual -W
build/guidedog serve docs/manual
Das Handbuch enthält die vollständige Odin-API-Referenz im Inhaltsverzeichnis. Der PDF-Befehl erzeugt ein Buch mit Links zwischen Erläuterungen und Deklarationen. Handbuch und getrenntes API-Projekt generieren die Referenz aus lib/. Eine kopierte API-Vorlage muss nicht synchron gehalten werden.
Um das API-Projekt separat zu bauen:
build/guidedog build html docs/api -W
build/guidedog build pdf docs/api -W
Diskussionen bauen und prüfen¶
build/guidedog gds index
build/guidedog gds check
build/guidedog gds build --target=both
Die GDS-CLI verwaltet Metadaten, Nummern, Zustand und Wiederherstellung. Die RST-Veröffentlichung ruft die Projektengine auf und erzeugt die vollständige HTML-Website sowie ein PDF je Aufzeichnung. Ein Selektor begrenzt nur die PDFs. HTML bleibt eine zusammenhängende Website mit vollständigem Katalog. Eine ausgewählte PDF-Vorschau nutzt _build/selected/<artifact>/pdf und lässt den Katalog in _build/pdf bestehen.
build/guidedog gds build guidedoc-odin --target=pdf
build/guidedog build html docs/gds -W
build/guidedog build pdf docs/gds -W
Die normalen Projektbefehle funktionieren ebenfalls. Das GDS-Projekt verwendet sein eigenes conf.toml und _build. Der Arbeitsablauf steht in docs/gds/workflow.rst.
Vor der Veröffentlichung¶
Prüfen Sie Links, Diagnosen, breite Tabellen und Codeblöcke. Rendern Sie nach Typografieänderungen die PDF-Seiten. Testen Sie HTML bei Desktop- und Handybreite sowie im hellen und dunklen Modus. Formeln und Diagramme müssen offline funktionieren. Bei Engineänderungen sind die passenden Bibliotheks- und Integrationstests auszuführen.