Skip to content
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.

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

Need high-level docs. #41

Closed
jberlanga opened this issue Jul 27, 2015 · 1 comment
Closed

Need high-level docs. #41

jberlanga opened this issue Jul 27, 2015 · 1 comment

Comments

@jberlanga
Copy link
Member

Hi @astroplanners/astroplanners-contributors,

I'm starting to write the docs and would like some input for what you would like to see/not see.

My starting point is to take the current RTD site and add:

  • A Tutorials page with separate pages for a few different use cases.
  • Getting Started would have a section explaining how the different types of objects correspond to observing concepts (e.g., target info contained in a Target object, etc.) and the way that you extract attributes/use methods in general. Perhaps also a section for basic tasks (such as creating Observer and Target objects).
  • A How to.. page linking to others that explain how to do specific things (e.g., extract alt/az info).
  • A Plots/Visualization page containing basic examples and linking to a detailed run-through of all the options for each plotting function.
@cdeil cdeil added this to the 0.1 release milestone Jul 28, 2015
@jberlanga jberlanga removed their assignment Aug 25, 2015
@cdeil
Copy link
Member

cdeil commented Aug 28, 2015

This was adressed in #42.

If someone has further suggestions, please open a new issue or PR.

@cdeil cdeil closed this as completed Aug 28, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants