-
Notifications
You must be signed in to change notification settings - Fork 0
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: remove explicit cookbook section numbering #262
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #262 +/- ##
=======================================
Coverage 51.61% 51.61%
=======================================
Files 29 29
Lines 3189 3189
=======================================
Hits 1646 1646
Misses 1543 1543 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
I wonder if they even need the "Cookbook - " prefix? Somewhat clear from the section header? |
See the code, I had removed that too haha |
If we do this, I think it would be good to add an overview at least to the first chapter that describes what is to come, just for user orientation. While I agree that it is implicit from the dropdown in the nav bar, that is not exactly a typical way to present the contents one can expect from a document.. I think the target audience is not necessarily one that hangs out on GH a lot, so I think being a bit more explicit somewhere in the cook book does not hurt Also, the links at the bottom of the chapters should be renamed as well then |
That makes sense. Then I will adjust. |
bit unsure why the macos check keeps failing, the same failure has recently been popping up elsewhere, but re-triggering it has usually solved it.. guess we may just have to wait and see, since it seems to be related to the latest R version |
definitely something widespread going on: Looks like either an intermittent GH Actions network problem, or something to do with the latest GH Actions macOS runners being arm64 and not x86 and possibly not building R or its dependencies properly. |
likely something with the supposedly a new version (20241022.361) is currently rolling out, last run here failed with the old version (20241119.509) at 2024.11.23 17:42 GMT+1 more detail likely related: actions/runner-images#10864 (comment) |
macOS-latest failure resolved by GitHub's latest macOS 14 runner image 20241125.556 |
I took the liberty to address this, so that we can close this PR soon @jdhoffa |
Thank you!! I will leave the rest of this PR to you then. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good, just one nit comment about making the section descriptions linkable
The order is defined implicitly by the order in which it appears on the
pkgdown.yml
:pacta.multi.loanbook/_pkgdown.yml
Lines 41 to 46 in 3f08f0d
Explicit numbering of the sections is superfluous and clunky.