Skip to content

DOC: Getting started should have a quick-start example #72

Closed

Description

@pllim

"Getting Started" looks pretty sparse:

Screenshot 2022-05-19 151149

What happens after installation? Would be nice to actually have "getting started to use the package" example too, not just installation.

Activity

  1. WilliamJamieson commented on May 19, 2022

    @WilliamJamieson
    Contributor

    There is no "quick-start" example here, asdf-astropy is just an extension library for asdf which provides the necessary extensions to serialize supported astropy objects. Any quick-start is equivalent to getting started with asdf (only with writing astropy specific objects, which is functionally the same as how asdf works with any other supported object when asdf-astropy is installed). Would a link to asdf's hello world be sufficient?

  2. pllim commented on May 19, 2022

    @pllim
    MemberAuthor

    Hmm, perhaps that is sufficient or feel free to close if you think this request is not actionable.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions