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 quickstart to README #549

Merged
merged 4 commits into from
Aug 21, 2024
Merged

Add quickstart to README #549

merged 4 commits into from
Aug 21, 2024

Conversation

mfisher87
Copy link
Member

No description provided.

Copy link

github-actions bot commented Aug 12, 2024

Binder 👈 Launch a binder notebook on this branch for commit 41079ea

I will automatically update this comment whenever this PR is modified

Binder 👈 Launch a binder notebook on this branch for commit 6e39f58

Binder 👈 Launch a binder notebook on this branch for commit cd99a96

Binder 👈 Launch a binder notebook on this branch for commit 950adf4

Copy link

codecov bot commented Aug 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.07%. Comparing base (fca67b9) to head (950adf4).
Report is 33 commits behind head on development.

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.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

Copy link
Member

@JessicaS11 JessicaS11 left a 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?

README.rst Outdated Show resolved Hide resolved
Co-authored-by: Jessica Scheick <JessicaS11@users.noreply.github.com>
@mfisher87
Copy link
Member Author

mfisher87 commented Aug 20, 2024

Great idea. How do you recommend highlighting the other "quick start" features we want users to know about (for instance ipx.Read()) here?

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.

@mfisher87 mfisher87 merged commit 6c6366a into development Aug 21, 2024
7 checks passed
@mfisher87 mfisher87 deleted the readme-quickstart branch August 21, 2024 21:18
RomiP added a commit to ICESAT-2HackWeek/icepyx that referenced this pull request Aug 21, 2024
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants