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

Switch to pkgdown Bootstrap 5 template #5505

Merged
merged 4 commits into from
Dec 9, 2023

Conversation

eitsupi
Copy link
Contributor

@eitsupi eitsupi commented Oct 30, 2022

Close #5503

The switch to bs5 will allow for search within the site, which will be very useful for users.

It will look like the following and a search window will be added in the upper right corner.

image

This PR is a small change to the pkgdown site configuration only; there are no changes to the document itself or to the R code.

How to test?

  1. Pull this branch.
  2. Run the pkgdown::build_site() function on the project root.
  3. The website code will be generated in the ./docs dir.

@codecov
Copy link

codecov bot commented Oct 30, 2022

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (ac57606) 97.46% compared to head (e3d9900) 97.46%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #5505   +/-   ##
=======================================
  Coverage   97.46%   97.46%           
=======================================
  Files          80       80           
  Lines       14822    14822           
=======================================
  Hits        14447    14447           
  Misses        375      375           

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

@eitsupi
Copy link
Contributor Author

eitsupi commented Apr 1, 2023

@jangorecki Could you take a look at this?

@jangorecki
Copy link
Member

LGTM

@eitsupi
Copy link
Contributor Author

eitsupi commented Nov 20, 2023

Could you merge this?
I think this is useful.

@jangorecki
Copy link
Member

Yes, we will merge. We are now on track to get data.table code contribution running smoothly. You may expect to wait for 1.15.99 to have it merged. Please see #5385 for justification.

@eitsupi eitsupi requested a review from mattdowle as a code owner December 9, 2023 14:40
@jangorecki
Copy link
Member

Any idea why this is not the default in pkgdown?

_pkgdown.yml Outdated Show resolved Hide resolved
@eitsupi
Copy link
Contributor Author

eitsupi commented Dec 9, 2023

Any idea why this is not the default in pkgdown?

This is a breaking change and we just need to opt in, check the pkgdown release notes.

_pkgdown.yml Outdated Show resolved Hide resolved
@eitsupi
Copy link
Contributor Author

eitsupi commented Dec 9, 2023

Anyway, this is not a major change and I see no reason why it cannot be merged immediately.
At the moment the documentation for data.table is very difficult for beginners to read as it is not searchable.

@jangorecki jangorecki merged commit f37f8e9 into Rdatatable:master Dec 9, 2023
4 of 5 checks passed
@eitsupi eitsupi deleted the pkgdown-bs5 branch December 9, 2023 15:37
@jangorecki
Copy link
Member

Website looks much better on the mobile browser now

@eitsupi
Copy link
Contributor Author

eitsupi commented Dec 10, 2023

Great! Thanks for merging this.

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.

Switch to pkgdown Bootstrap 5 template?
2 participants