Design Documentation and Code Improvements

[mpatrou]

It includes the design documentation and some additional improvements.

Short description of the changes:

• documentation: class, MVP, workflows, etc
• PySide6 issue fixed
• src/class renaming

Long description of the changes:

Check list for the pull request

• I have read the [CONTRIBUTING]
• I have read the [CODE_OF_CONDUCT]
• I have added tests for my changes
• I have updated the documentation accordingly

Check list for the reviewer

• I have read the [CONTRIBUTING]
• I have verified the proposed changes
• best software practices
  • all internal functions have an underbar, as is python standard
  • clearly named variables (better to be verbose in variable names)
  • code comments explaining the intent of code blocks
• All the tests are passing
• The documentation is up to date
• code comments added when explaining intent

Manual test for the reviewer

References

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.50%. Comparing base (18fb5d2) to head (c0668b7).
Report is 6 commits behind head on next.

Additional details and impacted files

@@           Coverage Diff           @@
##             next       #8   +/-   ##
=======================================
  Coverage   90.50%   90.50%           
=======================================
  Files           8        8           
  Lines         158      158           
=======================================
  Hits          143      143           
  Misses         15       15           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[AndreiSavici]

Minor changes

[AndreiSavici]

Minor changes required