Closed cosimoNigro closed 1 year ago
@cosimoNigro This is a good point. I will clean up the docs and describe the problem more technically. I think I will also link in the docs from astromodels for further reading on the technical details of the template models as ronswanson
is more focused on the the construction of the base data.
@grburgess, did you have time to improve the docs? That is to separate the installation from the tutorials and to better clarify the scope and applications of the package?
@cosimoNigro I have implemented these changes now.
Installation instructions have been separated from the example and the latter is much more clear. Thanks.
This issue is related to ronswanson's review for the journal of the open source software, specifically to the item:
Now in the docs there is a single
Intro
page with a brief statement of need, installation instructions and a first example. On the other hand, in the main doc page there is a brief introductory paragraph just stating:Though a conversational approach is always welcome in documentations, maybe the authors can better detail here the problem the software aims to solve, add some physical applications (what is the case of a simulation / analysis for which
ronswanson
would be useful?) and also for whom this software is helpful?Maybe it would be better to have the installation instructions separated from the first example. They can go in the main page as well.