Move docs from readme to markdown files and docstring

[pawelmagnu]

No description provided.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.02%. Comparing base (52b1d08) to head (62cebd3).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #459   +/-   ##
=======================================
  Coverage   92.02%   92.02%           
=======================================
  Files          30       30           
  Lines        1468     1468           
=======================================
  Hits         1351     1351           
  Misses        117      117           

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

[slayoo]

Thanks! This is going into the right direction!

Here are some notes taking at a first glance:

• the debugging_contribution.md file features content unrelated to the file name: Credits, Other open-source MPDATA implementations, Other Python packages for solving hyperbolic transport equations
• there are two instances of a reference to test-time-requirements.txt file, which does not exist anymore in the repo (instead, worth to explain the pip install PyMPDATA[tests] command)
• we should extend credits info with a mention of AGH and NCN
• I suggest to avoid repeating content in README from the other files - unmaintainable, could we just use the README.md instead of intro.md (now, e.g., the Credits info is in three files: README.md, index.html.jinja2 and debugging_and_contribution.md)?
• the schematic of the employed grid/domain layout in two dimensions is given below sentence is not followed by any graphic as of now
• the Python/Matlab/Julia codes are not featured in the menu - likely better to separate, introduce and highlight them somehow, now the first occurrence of the word "Julia" in the docs is in the Julia code (click to expand) (while Julia is even featured in the title of the PyMPDATA JOSS paper)?
• there is some copy-paste leftover in the README: PyMPDATA.applications, and provide a validation of the implementation...
• we are still missing a landing site for PyMPDATA-examples docs - there is just an unlabelled animation there
• I wonder how to guide the reader to click on the PyMPDATA item in the left menu from the landing site?