FFSH Dokumentation

8 Dez

Ab heute findet ihr oben im Menü unter „Mitgestalten“ einen neuen Eintrag: Dokumentation.
Dieser leitet euch zu readthedocs weiter, wo ihr ab sofort eine Dokumentation zu unseren Gateways, der Firmware und anderen Projekten findet.

Die Dokumentation pflegen wir auf GitHub in einem eigenen Repository.
Es gab bereits vorher Dokumentationen zu den einzelnen Projekten aber diese neue Lösung vereint die Dokumentation an einer Stelle und vereinfacht dank readthedocs den Arbeitsablauf. Ihr könnt gerne bei der Dokumentation helfen. Ziel ist nicht die Dokumentation von Gluon oder anderen Projekten zu ersetzen, sondern die Teile zu erklären die Freifunk Südholstein ausmachen. Außerdem soll durch die Dokumentation der Bus-Faktor verringert werden.

Wenn ihr Fehler findet, könnt ihr auf GitHub einen Issue erstellen oder gleich einen Pull-Request machen. Wer nicht weiß wie das geht, kann auch einfach eine E-Mail an github@freifunk-suedholstein.de senden.

Spread the love