Dokumentation überarbeiten

[cagix]

Die Dokumentation in allen Sub-Projekten benötigt eine Überarbeitung.

Dabei sollte auf folgende Punkte geachtet werden:

• Namen:
  • Das gesamte Projekt heisst "Dungeon". Man kann es auch ein "Framework" nennen.
  • Das Teilprojekt game heisst "Game: Dungeon Platform". Es stellt die Basis für das gesamte Projekt auf der Grundlage von libGDX und unter Zuhilfenahme des ECS-Architekturpatterns dar.
  • Das Teilprojekt dungeon heisst "Dungeon: Learning by Questing" (engl. Titel lassen). Es erweitert game, hier werden zusätzliche Spielelemente, die DSL sowie ein Compiler/Interpreter bereitgestellt.
  • Das Teilprojekt blockly heisst "Blockly: Low Code Dungeon". Es ergänzt dungeonund stellt eine auf Blockly basierende Low-Code-Schnittstelle zur Verfügung.
• README: In jedem Ordner der Doku sollte es eine Startdatei "README.md" geben.
• Pfade:
  • Passen die Pfade noch zu Abbildungen, Dokumentation, Code, ...?
  • Sind interne Links vernünftig eingebaut (Beispiel [blafasel](doc/quickstart.md) - nicht aber [blafasel](./doc/quickstart.md))?
• Interne Formatierung: Am besten mit pandoc -s -f markdown -t markdown --columns=94 --reference-links=true wuppie.md formatieren lassen - dabei aber aufpassen, dass keine Codeblöcke mit der Auszeichnung {=html} mit reinkommen (dort dann den ursprünglichen Markdowncode weiter benutzen)
• Inhalte: Passen die Inhalte noch? Passt das Level der Beschreibung zur Zielgruppe? Was ist zu "blumig" (und kann weg/gestrafft werden), wo fehlt noch was? => ggf. neue Tickets

Und wo wir schon mal dabei sind: Wo können wir alte Zöpfe radikal abschneiden? Brauchen wir beispielsweise wirklich sowas wie dungeon/doc/quickstart.md?