As discussed with @adrn and others on Slack, we would like to reorganize the Astropy developer docs.
The key points are to:
-
Add a top-level landing page for development documentation. For this we take inspiration particularly from NumPy's development docs: https://numpy.org/doc/stable/dev/index.html (I would not mind even going so far as to borrow some of their text almost verbatim). It would feature a clean and direct guide to getting started on Astropy (much less jumbled than this page.
-
At the bottom of the top-level page, add a table of contents for sub-pages that contain more detailed discussions. Most of those would be the same as the existing development pages, though some of them might merit additional reorganization/rewriting.
-
I like some aspects of the SciPy developer docs as well, especially the "ways to contribute" section: http://scipy.github.io/devdocs/dev/index.html
-
The matplotlib documentation is also a good inspiration. In particular we like the "choose your own adventure" style with prominent links for where to get started for different types of contributions.
-
Maybe rename from "Developer documentation" to "Contributor documentation" or "Contributor guide"?
As discussed with @adrn and others on Slack, we would like to reorganize the Astropy developer docs.
The key points are to:
Add a top-level landing page for development documentation. For this we take inspiration particularly from NumPy's development docs: https://numpy.org/doc/stable/dev/index.html (I would not mind even going so far as to borrow some of their text almost verbatim). It would feature a clean and direct guide to getting started on Astropy (much less jumbled than this page.
At the bottom of the top-level page, add a table of contents for sub-pages that contain more detailed discussions. Most of those would be the same as the existing development pages, though some of them might merit additional reorganization/rewriting.
I like some aspects of the SciPy developer docs as well, especially the "ways to contribute" section: http://scipy.github.io/devdocs/dev/index.html
The matplotlib documentation is also a good inspiration. In particular we like the "choose your own adventure" style with prominent links for where to get started for different types of contributions.
Maybe rename from "Developer documentation" to "Contributor documentation" or "Contributor guide"?