astropy
Request: Overhaul of documentation to make it easier to adopt ccdproc as a data reduction tool
I would like to request some (perhaps major) changes to be made to the documentation for ccdproc, to make it easier for novices to adopt the tool. This is because I am switching from using some pipeline to ccdproc, and I find the organization of the materials presented in the current documentation available at https://ccdproc.readthedocs.io/en/latest/ccdproc/index.html to be not very beginner-friendly. I can find the information I need by scrolling backward and forward and using the hyperlinks provided after a bit of effort. Though some improvement in this regard would be much appreciated. I noticed in a previous Issue #132 address part of this issue, which is still open. I have tried to use the ipython notebook example provided, but found it a little outdated.
Say, e.g. it may be better to add an example for the wcs attribute of the CCDData object, for the section at https://ccdproc.readthedocs.io/en/latest/ccdproc/ccddata.html#wcs.
@kakirastern thanks for the feedback. We would definitely welcome a pull request with any suggested improvements or even just more detailed feedback like your above comment. As having developed the package, having a fresh pair of eyes on the documentation is very helpful and the feedback is welcome. So any suggestions you have would be great.
Guess I could start from the "Page Contents" in the left-hand panel on https://ccdproc.readthedocs.io/en/latest/index.html#documentation. I would like to replace the item/link "Documentation" which currently acts like a placeholder to the following list of items/links instead, for a start:
- Installation
- CCD Data reduction
- Getting Started
- Contributors
- Full Changelog
- License
Am thinking about a way to override the existing setting(s)...