Online API-Dokumentation automatisch generieren

[ManuelHu]

Die Online API-Dokumentation sollte etwas automatischer gebaut werden, da sie aktuell ziemlich veraltet ist. Das letzte Mal hatte ich die Doku manuell im Jahr 2019 gebaut...

Am einfachsten geht das vermutlich mit GitHub Pages und einem entsprechenden CNAME-Record...

[tomwendel]

Gute Idee. Da bin ich ja quasi schon Profi. Hab das erst letzte Woche für das AntMe! Wiki umgestellt. ;) Dort verwenden wir ja jetzt https://docusaurus.io/

[ManuelHu]

Wir haben im Projekt OctoAwesome.Doc bereits seit langem eine (mittlerweile uralte) docfx-Version im Einsatz. Das generiert halt die Dokumentation aus dem C#-Code analog zu Sandcastle früher. Für CI ist doof, dass docfx immer noch nicht unter .NET (Core) 3,5,6 läuft, sondern immer noch in der stabilen Version .NET 4.x bzw. mono braucht... Aber die beta soll angeblich schon .NET 5,6 können...

Hier wäre halt die Frage, ob die Dokumentation überhaupt in der Form noch gewünscht ist. Ich bin ja auch nicht mehr so wirklich hier im Projekt drin :-)

[tomwendel]

Same hier. Wollte nur sagen: CNAME einrichten ist kein Problem.