[Tracking issue] Improve API and Developer documentation

[MFraters]

The developer documentation (https://gwb.readthedocs.io) is currently still mostly missing. This issue keeps track of the API and Developer manual which still need to be written. All pages already have a todo banner explaining what kind of content and/or what message the page should convey.

Please comment below if you are working on one of these pages, so no double work is done. Also don't forget to mention this issue in your pull request, so that it can be ticket off when it is merged.

API manual

• API design
• Available APIs - @gassmoeller
• API in different languages (FFI)

Developer Manual

• How to start developing and contributing
  • required and recommended tools
    • Git
    • Astyle -- @danieldouglas92 Add developer documentation for astyle #541
    • IDE -- @tjhei
  • Contributing to the GWB
    • Helping others
    • Making a pull request -- @Wang-yijun Add developer manual for making a pull request #567
    • Pull request review process -- @MFraters Add development documentation for the start devel and contributing, contributing to gwb index #618
      • What is continuous integration?
      • Testers
      • Code coverage
      • Benchmarking
      • Documentation testing
    • Pull request merging
• Contributing to the documentation -- @MFraters Add developer documentation index. #609
  • Creating documentation locally -- @danieldouglas92 Add developer manual for making a pull request #567
  • Important syntax -- @MFraters Add initial page for important myst syntax. #542
  • Documentation style guide -- @MFraters Add dev documentation style guide. #577
  • Documentation testing -- @MFraters Add development documentation page on documentation testing. #607
  • Tips and tricks -- @MFraters Remove dev docs tip and tricks. #608 (removing)
  • The review process
• Contributing to the code
  • Code documentation and Doxygen
  • Code conventions
  • Code Style Guide
  • Testing your code
    • Unit tests
    • integration testers
      • App tester
      • Visualization tester
      • Wrapper tester
  • Tips and tricks (mostly done already)
  • Review process
• Developing for the GWB
  • Code structure
  • Creating new plugins -- @alarshi Create plugin documentation #565
  • Changing or adding code
  • Creating a new plugin system @alarshi Add developer documentation for plugin systems. #598
  • Creating new tools

[alarshi]

I am working on Creating new plugins and Creating a new plugin system.