This repo contains all documentation for the minigame platform. Repos might contain further information but all information in this repo should be kept up to date.
All files in this repo should be written in English and Markdown.
It is structured in the following way:
Contains the Architecture Decision Records, so which general design decisions have been made, which options were possible, which were chosen and why.
Contains the developer manuals for the given repo or technology, meaning everything a developer needs to know about the specific topic to be able to collaborate.
Contains the installation manual(s) for the given repo, so how the admin can deploy the given service.
Contains manuals for lecturers and students, so how to use the platform and the minigames.
Contains protocols of meetings regarding the given repo/ concept for the given day. Filenames are in the
format YYYY-mm-dd-protocol.md.
The READMEs of all repos should follow the overall structure of the template README.
Important to note here is that the How to run and Development Setup instructions can and should be copy-pasteable
into the respective user- and dev-manual.