astropy / astropy/ccdproc

Request: Overhaul of documentation to make it easier to adopt ccdproc as a data reduction tool

Open
#657 5 comments 1 reaction 0 assignees View on GitHub
docs
Dominant language
Python
Stars
93
Forks
92
Avg merge
14h 44m
Merged PRs (30d)
30

Description

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](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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.