Documentation

[srosenbu]

We should start writing the docs for this repo. I started a documentation in NFDI4IngModelValidationPlatform and I am quite happy with the setup. I can just copy the basic files and then @saifr68 can start writing docs for the stress-rate implementatoin and I can start with the conventions for the models (Like gradients of vectors, order of stress components, etc.).

Do we want documentaion for the models or do we wait until we have decided how to continue with the repos? @aradermacher

[joergfunger]

The setup looks great and is a good starting point for a future documentation. However, I would wait until we have decided on howto proceed with the individual repos.

[srosenbu]

Since we reference this repo in a publication, we should at least make sure that the repo does not link to the old docs. Furthermore, people coming from the publication should get a better introduction into the package, so we should expand the README