1233 further enhance read the docs

[mknaranja]

Changes and Information

Please briefly list the changes (main added features, changed items, or corrected bugs) made:

• Updated and enhanced the documentation
• Updated the PR template for better visibility of the documentation needs
• Replaced READMEs in the model folders by links to corresponding documentation and code examples
• minor bugfixes

Merge Request - Guideline Checklist

Please check our git workflow. Use the draft feature if the Pull Request is not yet ready to review.

Checks by code author

• Every addressed issue is linked (use the "Closes #ISSUE" keyword below)
• New code adheres to coding guidelines
• No large data files have been added (files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
• Tests are added for new functionality and a local test run was successful (with and without OpenMP)
• Appropriate documentation for new functionality has been added (Doxygen in the code and Markdown files if necessary)
• Proper attention to licenses, especially no new third-party software with conflicting license has been added
• (For ABM development) Checked benchmark results and ran and posted a local test above from before and after development to ensure performance is monitored.

Checks by code reviewer(s)

• Corresponding issue(s) is/are linked and addressed
• Code is clean of development artifacts (no deactivated or commented code lines, no debugging printouts, etc.)
• Appropriate unit tests have been added, CI passes, code coverage and performance is acceptable (did not decrease)
• No large data files added in the whole history of commits(files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
• On merge, add 2-5 lines with the changes (main added features, changed items, or corrected bugs) to the merge-commit-message. This can be taken from the briefly-list-the-changes above (best case) or the separate commit messages (worst case).

Closes #1233

[mknaranja]

@kilianvolmer I opened the PR, could you edit my post and fill the changes list?

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.21%. Comparing base (c7f439d) to head (e2802ef).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1289   +/-   ##
=======================================
  Coverage   97.21%   97.21%           
=======================================
  Files         156      156           
  Lines       14674    14674           
=======================================
  Hits        14266    14266           
  Misses        408      408           

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[mknaranja]

I feel that the structure to work on the documents is a little bit messy. Maybe we could change the names to sort them? What do you think @kilianvolmer ?