RL Doku Proposal

[kim-mskw]

Made a first suggestion for a learning dokumentation. Added a paragraph for the provided exampels and uploaded the workshop examples as proper examples in the folder.

I copied something together. it definitely needs some work, but I wanted you feedback on the general idea first, before I finish it up. What do you guys think?

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (4a1f1a7) 80.37% compared to head (d66db6c) 80.37%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #221   +/-   ##
=======================================
  Coverage   80.37%   80.37%           
=======================================
  Files          39       39           
  Lines        4076     4076           
=======================================
  Hits         3276     3276           
  Misses        800      800           

Flag	Coverage Δ
pytest	80.37% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

[maurerle]

I think that this is in general very good and helpful!

I added the new files to the index, so that you can find them in the navigation on the left on the docs page using:
make -C docs html && python -m http.server --directory docs/build/html

You might want to convert your docs using a Markdown to RST conversion tool.

Other OS's than Windows care about capitalization in file names, so I fixed that too :)

[kim-mskw]

I did change the format hopefullz in the right waz. I, however, have problems buidling the docs. The port seems not reachable somehow. Does it work for someone else or did I break something?

Also I add github badges that link the colab tutorials.

[kim-mskw]

Sooo, I think I fixed everything :) please review the changes, as we should push the draft before the workshop tomorrow, and ideally we should add the description of the other example files as well.

[maurerle]

Looks good!

[maurerle]

Btw @kim-mskw after you have run the make command - you can run:
python -m http.server --directory docs/build/html 8090 <- with any open port (must be above 1024)

Maybe something is already running on port 8000 on your machine 🤷