📝 Document the Usage of Templates and add Rationale of QDMI

[ystade]

This PR adds a new page to the documentation that explains how to use the template provided together with QDMI. It adds another page explaining the motivation behind some design decisions within QDMI.

Remarks

This PR additionally includes the following changes:

• Updates the commit hash in the template
• Updates the logo, esp, makes it adapting to dark and bright mode
• Move C++ examples in examples to the front.
• Add the logo to the README.md.
• Makes the QDMI diagram adapt to the dark mode

[ystade]

I was wondering whether we actually want to fix the commit hash in the template or whether we just fetch the latest version on the default branch. What do you think, @burgholzer ?

[burgholzer]

I was wondering whether we actually want to fix the commit hash in the template or whether we just fetch the latest version on the default branch. What do you think, @burgholzer ?

Just for the sake of not having to regularly update the template, I think it makes most sense to use the default branch and add a comment that, once instantiated, people should be adjusting this to either a commit hash or a version pin to guarantee stability.

[ystade]

Two questions:

• Is there a way to check out the generated GitHub page before merging except locally?
• Where should the logo be placed in the README.md??

[burgholzer]

Two questions:

• Is there a way to check out the generated GitHub page before merging except locally?

Guess locally is the only real option here. But given how the GitHub page simply uses the output from doxygen and hosts that statically, that should be good enough, right?

• Where should the logo be placed in the README.md??

Maybe similarly to how we place it for the MQT repositories, i.e., right on top of the top-level header. The current image could then be moved below the header.

[ystade]

Then I guess, it is ready from my side.

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

@@            Coverage Diff            @@
##           develop     #90     +/-   ##
=========================================
- Coverage     86.3%   86.0%   -0.3%     
=========================================
  Files            7       7             
  Lines          799     798      -1     
  Branches       202     201      -1     
=========================================
- Hits           690     687      -3     
- Misses         109     111      +2     

Flag	Coverage Δ
cpp	86.0% <ø> (-0.3%)	:arrow_down:

Files with missing lines	Coverage Δ
examples/device/c/device.c	93.9% <ø> (ø)
examples/device/cxx/device.cpp	92.8% <ø> (-0.9%)	:arrow_down: