F overview

Summary

*index.rst, line 14 - 19 and 24 - 26

Focus

Point the reviewer to the core of the code change. Where should they start reading? What should they focus on (e.g. security, performance, maintainability, user-friendliness, compliance with the specs, finding more corner cases, concrete questions)?

Test Environment

How to set up a test environment for manual testing?

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related issues
• Up-to-date CHANGELOG.md (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md (or not necessary)
• Appropriate user and developer documentation (or not necessary)
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

doc/index.rst

@@ -10,11 +10,20 @@ Welcome to documentation of CaosDB's MySQL Backend!
    Getting started <README_SETUP>
    Concepts <concepts>
    Maintenance 
-   API documentation<functions>
+   API documentation <functions>
+   Advanced user tools <caosdb-advanced-user-tools>
+   Web UI <caosdb-webui>
+   PyLinkAhead <caosdb-pylib>
+   LinkAhead server <caosdb-server>
+   LinkAhead <caosdb-deploy>
+   Back to Overview <https://docs.indiscale.com/>
 
 This documentation helps you to :doc:`get started<README_SETUP>`, explains the most important
 :doc:`concepts<concepts>` .
 
+Or go back to the general `overview`_ of the documentation.
+
+.. _overview: https://docs.indiscale.com/
 
 Indices and tables
 ==================