generated from amosproj/amos202Xss0Y-projname
-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Description
User story
- As a user
- I want to easily reach the user documentation from the GUI
- 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__
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels
Type
Projects
Status
Product Backlog