Immer aktuell
Unsere Docs-Pipeline ist an das API-Repository gekoppelt. Ein Merge in main ohne aktualisierte Docs-Seite schlägt den CI-Check fehl. Veraltete Dokumentation ist bei uns ein Build-Fehler.
Dokumentation
Dokumentation, die du nicht erst googeln musst.
Wir schreiben Docs für Entwickler, die Zeit sparen wollen – nicht für Reviewprozesse.
Wie unsere Dokumentation aufgebaut ist
Gute Dokumentation ist kein Bonus-Feature – sie ist ein Teil des Produkts. Bei Astroapixel folgen wir dem Diátaxis-Framework: Tutorials führen neue Nutzer durch konkrete Aufgaben, How-to-Guides lösen spezifische Probleme, Referenzseiten beschreiben jeden Parameter vollständig, und Erklärseiten liefern den Kontext hinter Design-Entscheidungen. Jede Referenzseite zeigt echte Request- und Response-Beispiele in drei Sprachen: cURL, Python und TypeScript. Änderungen an der API werden gleichzeitig in der Dokumentation veröffentlicht – kein Lag zwischen Code und Docs.
Was unsere Docs von anderen unterscheidet
Ausführbare Beispiele
Alle Code-Snippets sind gegen die Sandbox-API getestet. Du kannst sie kopieren, den API-Key eintragen und sofort ausführen – kein manuelles Anpassen von Platzhaltern.
Feedback direkt in den Docs
Jede Seite hat ein eingebettetes Feedback-Widget. Kommentare landen direkt bei unserem technischen Schreiber, der werktags innerhalb von 24 Stunden antwortet oder die Seite aktualisiert.
Häufige Fragen zur Dokumentation
In welchen Sprachen gibt es Code-Beispiele?
Alle Referenzseiten zeigen Beispiele in cURL, Python 3 und TypeScript. Für Go und Java stellen wir generierte Client-Libraries bereit, die wir im Abschnitt SDKs verlinken.
Wie melde ich einen Fehler in der Dokumentation?
Jede Docs-Seite hat unten einen Button „Fehler melden“. Alternativ öffnest du direkt ein Issue im öffentlichen GitHub-Repository unter github.com/astroapixel/docs. Wir triagen Docs-Issues täglich.
Gibt es eine Offline-Version der Docs?
Ja. Du kannst die gesamte Dokumentation als PDF oder als statische HTML-Site exportieren. Den Export-Button findest du oben rechts auf jeder Hauptkategorie-Seite.
Sind die Docs auf Englisch verfügbar?
Die Hauptdokumentation ist auf Deutsch und Englisch verfügbar. Den Sprachumschalter findest du in der oberen Navigationsleiste der Docs-Seite.
Überzeug dich selbst – die Docs sind öffentlich.
Kein Account nötig, um die komplette Referenzdokumentation zu lesen.
Dokumentation öffnen