-
Notifications
You must be signed in to change notification settings - Fork 107
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 quickstart to README #549
Conversation
👈 Launch a binder notebook on this branch for commit 41079ea I will automatically update this comment whenever this PR is modified 👈 Launch a binder notebook on this branch for commit 6e39f58 👈 Launch a binder notebook on this branch for commit cd99a96 👈 Launch a binder notebook on this branch for commit 950adf4 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## development #549 +/- ##
============================================
Coverage 65.07% 65.07%
============================================
Files 36 36
Lines 3052 3052
Branches 538 538
============================================
Hits 1986 1986
Misses 981 981
Partials 85 85 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great idea. How do you recommend highlighting the other "quick start" features we want users to know about (for instance ipx.Read()
) here?
Co-authored-by: Jessica Scheick <JessicaS11@users.noreply.github.com>
I think we shouldn't try to be comprehensive here, but link to perhaps a documentation page that helps users quick start with other features. The notebooks that follow the quick start section, IMO, do a great job of bringing comprehensiveness. What I'm going for with this addition is to build up the "mouth" (the broadest, shallowest part) of our contributor funnel a little more. When someone comes to the repo and asks "what can this thing do for me?" having one working example can go a huge distance to the user visualizing themselves using the thing, and move them into the funnel. |
* Add quickstart to README (icesat2py#549) Co-authored-by: Jessica Scheick <JessicaS11@users.noreply.github.com> * create class outline for gedi --------- Co-authored-by: Matt Fisher <mfisher87@gmail.com> Co-authored-by: Jessica Scheick <JessicaS11@users.noreply.github.com>
No description provided.