New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Overhaul Documentation and Examples #466

Open

4 tasks

tskisner opened this issue Sep 18, 2021 · 0 comments

Assignees

Milestone

Member

tskisner commented Sep 18, 2021

This issue is to track the changes that are needed for the documentation

Restructure the sphinx docs. Background info, update installation section. Data and processing model updates. Organize operators by simulation / reduction and group by topic. Add section on workflow script creation / configuration.
Update example / tutorial notebooks
Add developer documentation: focus on the most common cases, building new operators, git flow, coding guidelines
Include discussion of example workflows

tskisner added this to the Release 3.0 milestone

tskisner self-assigned this

tskisner mentioned this issue

Updated Simulated Sky Signal Tutorial ? #526

Open

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment