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

New JupyterBook introduction #50

Merged
merged 5 commits into from
Oct 19, 2023
Merged

New JupyterBook introduction #50

merged 5 commits into from
Oct 19, 2023

Conversation

Swanson-Hysell
Copy link
Member

This pull request adds:

  • a new intro.md that introduces the project and directs the user to the two main DIY notebooks and succinctly provides additional information
  • a new installation.md that contains the installation information previously in the GitHub readme
  • updates logo.png to be a portion of Figure 1 that is more relevant to the book context than the Euler pole illustration
  • adjusts the toc given the new files

The goal is to make an intro markdown file that quickly directs the
user to the most relevant notebooks.
Add the new intro and installation markdown files.
Adjust order of analysis notebooks.
@Swanson-Hysell Swanson-Hysell added the documentation Improvements or additions to documentation label Oct 18, 2023
@codecov
Copy link

codecov bot commented Oct 18, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (8e49ae7) 87.04% compared to head (6b631ee) 87.04%.
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #50   +/-   ##
=======================================
  Coverage   87.04%   87.04%           
=======================================
  Files           9        9           
  Lines         301      301           
=======================================
  Hits          262      262           
  Misses         39       39           

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

@facusapienza21
Copy link
Member

@Swanson-Hysell I am accepting the PR but I will later change the logo again: I was working in a simplified version of the previous logo to make it personalized for this work, but I will prefer to keep something cosmetic instead of the paper figure. Thanks for the JB updates!

@facusapienza21 facusapienza21 merged commit 7cd960e into main Oct 19, 2023
3 checks passed
@Swanson-Hysell
Copy link
Member Author

The book is looking nice! Sounds good with regard to the logo. Note that the logo.png image (i.e. the snippet of Fig 1) is being called upon for the first graphic grid. So when you put in a new logo, go ahead and rename the current logo png as something else and update the associated file call in the intro.md.

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
Development

Successfully merging this pull request may close these issues.

2 participants