Docs

This repository contains all documentation of the GITS - Gamified Intelligent Tutoring System Enpro number 2. The documentation uses read the docs and is also hosted by them on read the docs GITS.

Structure

All files in this repo should be written in English and Markdown.

It is structured in the following way:

/adr

Contains the Architecture Decision Records, so which general design decisions have been made, which options were possible, which were chosen and why.

/dev-manuals

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.

/install-manuals

Contains the installation manual(s) for the given repo, so how the admin can deploy the given service.

/user-manuals

Contains manuals for lecturers and students on how to use the platform.