smash-transport / sparkx

SPARKX - Software Package for Analyzing Relativistic Kinematics in Collision eXperiments
https://smash-transport.github.io/sparkx/
GNU General Public License v3.0
5 stars 0 forks source link

Add Quickstart page #272

Open nilssass opened 3 weeks ago

nilssass commented 3 weeks ago

As the number of classes is increasing, it will be very hard for users to see where to begin, especially in our documentation.

I would suggest to add one documentation page after Install called Quick Guide where we briefly describe the usecases connected to each class in a meaningful hierarchy and give some super easy example. Maybe there is even a way to make this page downloadable or add a download button that will download the connected user guide as pdf

Hendrik1704 commented 2 weeks ago

A first draft for the quickstart guide was implemented in #275. After the next updates of the development branch we should continue with this.