search

SE-TINF22B2 / G5-DuoGradus

Sammle Schritte, Tritt gegen Freunde an und steig in deiner Liga auf!
https://docs.duo-gradus.de
Apache License 2.0
3 stars 1 forks source link

Verschiedene Orte für Dokumentation #131

Closed henrybrink closed 3 months ago

henrybrink commented 4 months ago

Derzeit haben wir mehre Orte in denen noch Dokumentation zu finden ist, diese sollten alle in die neue Dokumentation überführt werden.

obsolete Dokumentation:

Ich würde vorschlagen diese Ordner / Dateien entfernen und das Wiki zu deaktivieren / an die Dokumentation weiterzuleiten.

benedictweis commented 4 months ago

Im Wiki befindest sich bereits eine deprecated warning und ein Termin zu dem es abgeschaltet wird. Die frontend und backend Dokumentation war damals der Gedanke dass die Dinge die den Code direkt betreffen bzw. In Zukunft auch direkt aus dem Code generiert werden könnten (besonders beim frontend) in separaten Ordnern zu habe. Wenn es allen lieber ist das lieber in der Projekt Dokumentation zu haben ändere ich das sofort.

henrybrink commented 4 months ago

Sehr gut, die Deprecated Warnung ist mir noch nicht aufgefallen.

Testing etc muss entweder in die Guidelines / den neuen "Development"-Teil des Wikis, autogenerierte Docs für die technische API sind eine sinnvolle Idee, aber ich würde maximal diese in den Ordnern lassen - sonst findet man nichts wieder. Und eigentlich sollten diese auch über Pages zugänglich sein.

benedictweis commented 4 months ago

Alles klar, dann mache ich das so.

benedictweis commented 3 months ago

Geschlossen durch #148.