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

Add "Getting Started" section to docs #240

Closed
6 tasks done
Tracked by #245
hCraker opened this issue Sep 2, 2022 · 0 comments · Fixed by #249
Closed
6 tasks done
Tracked by #245

Add "Getting Started" section to docs #240

hCraker opened this issue Sep 2, 2022 · 0 comments · Fixed by #249
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@hCraker
Copy link
Contributor

hCraker commented Sep 2, 2022

Describe the feature you'd like added to this project
Currently our docs page doesn't have a "quick start" section like most other PyData packages. Adding a few pages describing why geocat-comp exists, what it is, basic install instructions, and an overview of some of the content would aid new users in getting introduced to the package.

Some potential topics to cover:

  • what is geocat-comp and why was it made
  • install instructions
  • overview of project structure
  • talk about what -f2py is and how it works with -comp
  • provide examples of basic workflows
  • how to get support / report bugs / open GItHub issues

Additional context
Xarray has a really great "Getting Started" page, and we can use it as a model to build off of.

This work is prep for the tutorial in October #239

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
2 participants