Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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:

...

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

Diagrams, flowcharts etc.

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

...