Project

General

Profile

Feature #1065

Updated by Alexander Watzinger 5 months ago

At the moment the user manual is available in "Redmine":https://redmine.openatlas.eu/projects/uni/wiki/Documentation which we will replace with

Moving it to the application would have
a manual inside the application. few advantages e.g.

*Advantages*
* More layout option to improve readability
* The manual would correlate to the specific version of the application

*Ideas*
* Evaluate
Most likely we will implement it with "Sphinx":https://www.sphinx-doc.org/en/master/
*


Add workflow examples in documentation (e.g. acquisition, letter correspondence)
* Look into automated code comment generation


Back