Skip to content

Need high-level docs. #41

Closed
Closed

Description

@jberlanga

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.

Activity

  1. added this to the 0.1 release milestone on Jul 28, 2015
  2. removed their assignment
    on Aug 25, 2015
  3. cdeil commented on Aug 28, 2015

    @cdeil
    Member

    This was adressed in #42.

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

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions