Skip to content

MEITREX/wiki

Repository files navigation

Docs

This repository contains all documentation of the MEITREX - Modular Embedded Intelligent Tutoring and Remote Education eXperience. The documentation uses read the docs and is also hosted by them on read the docs MEITREX.

Structure

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 on how to use the platform.