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

Improve Getting Started vignette #234

Merged
merged 20 commits into from
Mar 27, 2024
Merged

Improve Getting Started vignette #234

merged 20 commits into from
Mar 27, 2024

Conversation

jamesmbaazam
Copy link
Member

@jamesmbaazam jamesmbaazam commented Mar 21, 2024

This PR improves the Getting Started vignette to reduce the technical barrier to understanding the original text. In particular, It

Note that this vignette contains styling that is only properly viewed by building the website using pkgdown::build_site() in your local copy of this repository.

@codecov-commenter
Copy link

codecov-commenter commented Mar 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.80%. Comparing base (3fe2965) to head (3b9a8f7).

❗ Current head 3b9a8f7 differs from pull request most recent head d020306. Consider uploading reports for the commit d020306 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #234   +/-   ##
=======================================
  Coverage   98.80%   98.80%           
=======================================
  Files           8        8           
  Lines         587      587           
=======================================
  Hits          580      580           
  Misses          7        7           

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

@jamesmbaazam jamesmbaazam marked this pull request as ready for review March 22, 2024 13:08
@jamesmbaazam jamesmbaazam changed the title Improvements to Getting Started Vignette Improve Getting Started vignette Mar 22, 2024
Copy link
Contributor

@sbfnk sbfnk left a comment

Choose a reason for hiding this comment

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

Wow, looks really great. Lots of little suggestions, sorry.

vignettes/epichains.Rmd Outdated Show resolved Hide resolved
vignettes/epichains.Rmd Outdated Show resolved Hide resolved
vignettes/epichains.Rmd Outdated Show resolved Hide resolved
vignettes/epichains.Rmd Outdated Show resolved Hide resolved
vignettes/epichains.Rmd Outdated Show resolved Hide resolved
vignettes/epichains.Rmd Show resolved Hide resolved
vignettes/epichains.Rmd Outdated Show resolved Hide resolved
vignettes/epichains.Rmd Outdated Show resolved Hide resolved
vignettes/epichains.Rmd Outdated Show resolved Hide resolved
vignettes/epichains.Rmd Outdated Show resolved Hide resolved
Copy link
Member

@adamkucharski adamkucharski left a comment

Choose a reason for hiding this comment

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

Nice work. I see Seb has already added several comments, so just a few additional minor points from me.

vignettes/epichains.Rmd Outdated Show resolved Hide resolved
vignettes/epichains.Rmd Outdated Show resolved Hide resolved
vignettes/epichains.Rmd Outdated Show resolved Hide resolved
@jamesmbaazam
Copy link
Member Author

Nice work. I see Seb has already added several comments, so just a few additional minor points from me.

Thanks for taking a look.

@jamesmbaazam jamesmbaazam requested a review from sbfnk March 26, 2024 22:34
@jamesmbaazam
Copy link
Member Author

@sbfnk Could you approve if you're happy?

@jamesmbaazam jamesmbaazam merged commit 0ef7e2b into main Mar 27, 2024
8 checks passed
@jamesmbaazam jamesmbaazam deleted the improve-gs-vignette branch March 27, 2024 11:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants