Technical documentation

All things related to the (technical) documentation of OS2valghalla 3.0

Technical documentation

It has been decided to use the table of contents from https://os2iot.readthedocs.io/en/latest/index.html as inspiration for the structure of the technical documentation.

Setup/infrastructure

All technical documentation is done in a GitHub repository that is connected to Read the docs:

• Read the docs documentation: https://os2valghalla.readthedocs.io/en/latest/

• Read the docs admin (ask Mogens for access): OS2valghalla | Read the Docs

• GitHub repository (ask Mogens for access): GitHub - OS2Valghalla/OS2valghalla-3-documentation: Documentation of OS2valghalla 3

It has been decided that reStructedText (RST) will be used as markup language for the documentation.

• RST for Sphinx documentation can be found here: reStructuredText Primer — Sphinx documentation

Diagrams, flowcharts etc.

All diagrams, flowcharts etc. used in the technical documentation should be done in either Microsoft Visio or Whimsical.

Please upload and find files in Project files .

Please add Mogens (movk@aarhus.dk) as user with edit rights on all Whimsical projects.