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

Minor docs update #36

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Minor docs update #36

wants to merge 5 commits into from

Conversation

dennisbrookner
Copy link
Member

So far in this PR, I have

  • reordered the pages on the website so that the command-line reference comes first
  • added a placeholder "coming soon!" tutorial page, where we can add the tutorial in markdown format.

I figure we can leave this PR open while the tutorial continues to take shape.

Copy link

codecov bot commented Nov 8, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (6197f3d) 44.12% compared to head (fc7f785) 44.12%.
Report is 56 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #36   +/-   ##
=======================================
  Coverage   44.12%   44.12%           
=======================================
  Files           4        4           
  Lines         281      281           
  Branches       19       19           
=======================================
  Hits          124      124           
  Misses        152      152           
  Partials        5        5           
Flag Coverage Δ
unittests 44.12% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@PrinceWalnut
Copy link
Member

I have a couple of edits to make to the notebook based on feedback from Maggie Klureza. I'll make sure to push them by end of week, and perhaps we can include the tutorial into this PR. Let me know if you want to take that on, and what format would be easiest for you to work with @dennisbrookner.

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