README.md ist momentan riesig und bei der Wall of Text echt unübersichtlich.
Die README.md "user-friendly" machen, nur essentielles soll drinnen stehen
Details entweder in ein separates DETAILS.md
oder das Gitea Wiki verwenden (bitte noch abklären bzw. checken ob das eine gute Idee ist)
README.md ist momentan riesig und bei der Wall of Text echt unübersichtlich.
- Die README.md "user-friendly" machen, nur essentielles soll drinnen stehen
- Details entweder in ein separates DETAILS.md
- oder das Gitea Wiki verwenden (bitte noch abklären bzw. checken ob das eine gute Idee ist)
Die zwölf ##-Abschnitte der alten README (992 Zeilen, 14 130 Wörter) sind wortgleich zu zwölf Wiki-Seiten geworden, per Skript an den Abschnittsgrenzen geschnitten und mit Abdeckungsbeweis (jede README-Zeile landet genau einmal; nicht erfasst sind nur Kopf und Leerzeilen). Seiten: Concepts, Scene editing, Behaviors, Colliders, Textures, Animations, State machines, Containers, Keyboard · Architecture, Development, API. Dazu Home (Index, Ideas, gaps and bugs, Not yet) und _Sidebar.
Drei Absätze standen an der falschen Stelle und sind umsortiert: Placing / Editor symbols / Z-order / Hierarchy / Editor offset hingen unter Behaviors → eigene Seite Scene editing; Limits (Upload-Grenzen) stand hinter State machines → Textures; Screens without scene switching → Containers. Vier „see X below"-Verweise, die jetzt über Seitengrenzen gehen, sind Wiki-Links.
README neu (~70 Zeilen): Was es ist, fünf Sätze Kern, Quick-Start, die Testbefehle mit dem Hinweis „voller Lauf ist CI", Seitenindex, Tracker-Link. shortcuts.ts verwies auf „README Keyboard", jetzt auf die Wiki-Seite.
Warum Wiki statt DETAILS.md / docs/
Das Wiki ist im UI ein Tab des Projekts, in Git ein zweites Bare-Repo (game-maker.wiki.git, eigene Historie – ein Klon des Haupt-Repos enthält es nicht). Die Nachteile sind klein: Doku-Änderungen sind ein zweiter Push, und kein Gate sieht sie – aber .prettierignore schließt *.md ohnehin aus, die README lief nie durch Prettier. Dafür: Bearbeiten direkt im Browser, Seitenleiste, Seiten statt einer Wall of Text.
Geprüft
14 Seiten über die API, alle [x](Y)-Ziele existieren als Datei; Concepts rendert die vier neuen Links (href="/meleki/game-maker/wiki/…"), _Sidebar.md erscheint als wiki-content-sidebar.
**Erledigt – die Doku ist jetzt das Wiki, die README ist kurz.**
Wiki: https://git.nockal.com/meleki/game-maker/wiki (Wiki-Commit `9be1294`) · README: Commit `f0673d1`
### Was gemacht wurde
- Die zwölf `##`-Abschnitte der alten README (992 Zeilen, 14 130 Wörter) sind **wortgleich** zu zwölf Wiki-Seiten geworden, per Skript an den Abschnittsgrenzen geschnitten und mit Abdeckungsbeweis (jede README-Zeile landet genau einmal; nicht erfasst sind nur Kopf und Leerzeilen). Seiten: Concepts, Scene editing, Behaviors, Colliders, Textures, Animations, State machines, Containers, Keyboard · Architecture, Development, API. Dazu `Home` (Index, *Ideas, gaps and bugs*, *Not yet*) und `_Sidebar`.
- Drei Absätze standen an der falschen Stelle und sind umsortiert: *Placing / Editor symbols / Z-order / Hierarchy / Editor offset* hingen unter *Behaviors* → eigene Seite **Scene editing**; *Limits* (Upload-Grenzen) stand hinter *State machines* → **Textures**; *Screens without scene switching* → **Containers**. Vier „see *X* below"-Verweise, die jetzt über Seitengrenzen gehen, sind Wiki-Links.
- **README neu** (~70 Zeilen): Was es ist, fünf Sätze Kern, Quick-Start, die Testbefehle mit dem Hinweis „voller Lauf ist CI", Seitenindex, Tracker-Link. `shortcuts.ts` verwies auf „README Keyboard", jetzt auf die Wiki-Seite.
### Warum Wiki statt `DETAILS.md` / `docs/`
Das Wiki ist im UI ein Tab des Projekts, in Git ein zweites Bare-Repo (`game-maker.wiki.git`, eigene Historie – ein Klon des Haupt-Repos enthält es nicht). Die Nachteile sind klein: Doku-Änderungen sind ein zweiter Push, und kein Gate sieht sie – aber `.prettierignore` schließt `*.md` ohnehin aus, die README lief nie durch Prettier. Dafür: Bearbeiten direkt im Browser, Seitenleiste, Seiten statt einer Wall of Text.
### Geprüft
- 14 Seiten über die API, alle `[x](Y)`-Ziele existieren als Datei; *Concepts* rendert die vier neuen Links (`href="/meleki/game-maker/wiki/…"`), `_Sidebar.md` erscheint als `wiki-content-sidebar`.
- `./check.sh`: `=== CHECK EXIT 0 ===`, 831 Tests. Server-HEAD `f0673d1` = lokal.
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
README.md ist momentan riesig und bei der Wall of Text echt unübersichtlich.
Erledigt – die Doku ist jetzt das Wiki, die README ist kurz.
Wiki: https://git.nockal.com/meleki/game-maker/wiki (Wiki-Commit
9be1294) · README: Commitf0673d1Was gemacht wurde
##-Abschnitte der alten README (992 Zeilen, 14 130 Wörter) sind wortgleich zu zwölf Wiki-Seiten geworden, per Skript an den Abschnittsgrenzen geschnitten und mit Abdeckungsbeweis (jede README-Zeile landet genau einmal; nicht erfasst sind nur Kopf und Leerzeilen). Seiten: Concepts, Scene editing, Behaviors, Colliders, Textures, Animations, State machines, Containers, Keyboard · Architecture, Development, API. DazuHome(Index, Ideas, gaps and bugs, Not yet) und_Sidebar.shortcuts.tsverwies auf „README Keyboard", jetzt auf die Wiki-Seite.Warum Wiki statt
DETAILS.md/docs/Das Wiki ist im UI ein Tab des Projekts, in Git ein zweites Bare-Repo (
game-maker.wiki.git, eigene Historie – ein Klon des Haupt-Repos enthält es nicht). Die Nachteile sind klein: Doku-Änderungen sind ein zweiter Push, und kein Gate sieht sie – aber.prettierignoreschließt*.mdohnehin aus, die README lief nie durch Prettier. Dafür: Bearbeiten direkt im Browser, Seitenleiste, Seiten statt einer Wall of Text.Geprüft
[x](Y)-Ziele existieren als Datei; Concepts rendert die vier neuen Links (href="/meleki/game-maker/wiki/…"),_Sidebar.mderscheint alswiki-content-sidebar../check.sh:=== CHECK EXIT 0 ===, 831 Tests. Server-HEADf0673d1= lokal.