Project

General

Profile

Feature #1065

User manual in application

Added by Alexander Watzinger 6 months ago. Updated 10 days ago.

Status:
Acknowledged
Priority:
Low
Assignee:
-
Category:
Frontend
Target version:
Start date:
2019-08-05
Estimated time:

Description

At the moment the user manual is available in Redmine which we will replace with a manual inside the application.

Advantages
  • More layout option to improve readability
  • The manual would correlate to the specific version of the application
Ideas
  • Evaluate Sphinx
  • Add workflow examples in documentation (e.g. acquisition, letter correspondence)
  • Look into automated code comment generation

Related issues

Follows Feature #1048: Bootstrap layoutClosed2019-08-02Actions

History

#1

Updated by Alexander Watzinger 6 months ago

  • Description updated (diff)
#2

Updated by Alexander Watzinger 3 months ago

  • Target version changed from 4.1.0 to 5.0.0
#3

Updated by Alexander Watzinger 3 months ago

  • Start date changed from 2019-10-05 to 2019-08-05
  • Follows Feature #1048: Bootstrap layout added
#4

Updated by Alexander Watzinger 2 months ago

  • Target version changed from 5.0.0 to 5.1.0
#5

Updated by Alexander Watzinger 10 days ago

  • Description updated (diff)

Also available in: Atom PDF