Kurze Beschreibung anstatt der vollen Projektbeschreibung. Fokus auf die Nutzergruppen
Getting Started Abschnitt:
Installations Abschnitt mit Beschreibung der Installation des SDK. Aktuell wird hier von einer Installation mit git clone ausgegangen und nicht mit PyPI.
Abschnitt wie man seinen ersten Fragetypen erstellt
FAQ. Hier sollen Fragen beantwortet werden, die an mehreren Stellen in der Dokumentation auftreten können.
Documentation Abschnitt:
Dieser Abschnitt soll einzelne Komponente detailiert beschreiben.
Dokumentation für Admins und Teacher.
Reference Abschnitt:
Beschreibung der APIs und des Codes.
Aktuell wird das automatisch generiert durch mkdocstrings kann aber ergänzt werden später.
Andere:
Submodules geupdated
mkdocs und plugins geupdated
Aktuell sind wir bei Version 1.5.3 aber ab mkdocs 1.6 sollen ein paar Änderungen kommen, wodurch jetzt deprecated Warnungen ausgegeben werden. Ich glaube das kommt durch das mkdocs-awesome-pages-plugin, wo das letzte Update im August released wurde.
Inhaltliche Änderungen:
git clone
ausgegangen und nicht mit PyPI.Andere:
1.5.3
aber ab mkdocs1.6
sollen ein paar Änderungen kommen, wodurch jetztdeprecated
Warnungen ausgegeben werden. Ich glaube das kommt durch das mkdocs-awesome-pages-plugin, wo das letzte Update im August released wurde.