Skip to content

Integrate User Documentation into GUI #120

@AndreasFreund

Description

@AndreasFreund

User story

  1. As a user
  2. I want to easily reach the user documentation from the GUI
  3. So that I have an easy way to troubleshoot if something goes wrong

Acceptance criteria

  • Think about an easy way to include our current documentation into the application
  • There should be no manual keeping in sync between repository and app, so it should be included in the build process
  • Possible solution: convert all .md files in Repo to .html / .pdf or similar, add a link from the GUI which opens the folder containing the documentation or opens the browser with the main .html file containing links to the other documents
  • Alternative solution (probably more annoying): Use the QT help framework for creating the documentation in the app

Definition of done (DoD)

  • Code review has been completed
  • Code has been merged
  • Feature branch has been deleted
  • Update method signatures in architecture diagram
  • MCU & GUI build after merge__

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Product Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions