Open parth-07 opened 2 years ago
Hi Parth! thanks for this issue, can you also just mark what goes in the readme and what in readthedocs? Thanks!
I signed up for a bunch of items.
Hi everyone, restructured the readme a little here: https://github.com/grimmmyshini/clad/tree/docs-readme-restructure#clad.
Things left to do in the README:
can you also just mark what goes in the readme and what in readthedocs?
All of these tasks should go in the readthedocs. I will mention this in the issue as well. For many items, we can just reuse the existing material from GitHub Readme and already existing material from readthedocs (but it needs to be restructured because we are also changing the layout).
fill out the information in what can be differentiated.
I am not sure if we should keep this section in the GitHub Readme. We want the GitHub readme to be very minimal, right?
fill out the information in what can be differentiated.
I am not sure if we should keep this section in the GitHub Readme. We want the GitHub readme to be very minimal, right?
Yes, but I think we can just add a line there directing to a more elaborate list of what can be differentiated?
Yes, but I think we can just add a line there directing to a more elaborate list of what can be differentiated?
Yes, this sounds like a good idea.
This issue is created to keep track of progress and responsibilities for the Clad documentation hackathon.
The following concepts along with their person-in-charge are as follows: '?' is used if no person is assigned responsibility yet for the particular task.
clad::differentiate
(?)clad::gradient
(?)clad::hessian
(?)clad::jacobian
(?)clad::estimate_error
(Garima)All of these items should go on the clad readthedocs website. For GitHub readme, we can reuse the introduction and add a link to a few other necessary sections that takes to the readthedocs website.
This document can be used as a rough outline to follow for the documentation.