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

docs: add getting started guide #98

Merged
merged 6 commits into from
Jun 5, 2024
Merged

docs: add getting started guide #98

merged 6 commits into from
Jun 5, 2024

Conversation

ianna
Copy link
Member

@ianna ianna commented Jun 5, 2024

No description provided.

Copy link

codecov bot commented Jun 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.27%. Comparing base (5b18d99) to head (7ce2fd4).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #98   +/-   ##
=======================================
  Coverage   75.27%   75.27%           
=======================================
  Files           4        4           
  Lines        1630     1630           
=======================================
  Hits         1227     1227           
  Misses        403      403           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ianna ianna marked this pull request as draft June 5, 2024 10:08
@ianna ianna marked this pull request as ready for review June 5, 2024 11:31
Copy link
Member Author

@ianna ianna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ianna ianna changed the title [docs] add getting started docs: add getting started Jun 5, 2024
@ianna ianna changed the title docs: add getting started docs: add getting started guide Jun 5, 2024
@jpivarski
Copy link
Member

It looks great! This can definitely get new users started. If they're familiar with Awkward Array from Python, they might get to the end of the documentation and still be looking for the ak.* equivalents, not realizing that the way they ought to be used in Julia is different: compiled for loops are not something to be avoided. This could, perhaps, be clarified with usage examples, such as a Z peak, with lots of for loops. But a more important first step would be to get physicist users involved. First adopters would figure out what the best practices are, and maybe also find design issues that need to be fixed.

@ianna ianna merged commit 7386320 into main Jun 5, 2024
7 checks passed
@ianna ianna deleted the ianna/docs_getting_started branch June 5, 2024 14:03
@Moelf
Copy link
Member

Moelf commented Jun 5, 2024

At some point we probably want to make the documentation entries less redundant, I will see what I can do

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.

3 participants