Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrate User Documentation into GUI #120

Open
AndreasFreund opened this issue Jun 26, 2024 · 0 comments
Open

Integrate User Documentation into GUI #120

AndreasFreund opened this issue Jun 26, 2024 · 0 comments

Comments

@AndreasFreund
Copy link
Contributor

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__
@AndreasFreund AndreasFreund converted this from a draft issue Jun 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Product Backlog
Development

No branches or pull requests

1 participant