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

Upgrade theme #752

Merged
merged 36 commits into from
Apr 12, 2023
Merged

Upgrade theme #752

merged 36 commits into from
Apr 12, 2023

Conversation

stevepiercy
Copy link
Contributor

@stevepiercy stevepiercy commented Apr 2, 2023

Here are changes that I found. Some may affect our customizations, others I don't know if there is a replacement yet. We need to discuss.

  • New search input removes our customized search input.
  • Search results input loses CMD-K hint and UI is strange. I think we could modify the default by adding a clear button, instead of trying to preserve the existing UI.
  • html_theme_options.extra_navbar is just gone. It's not even documented in any of the theme's ancestors. I don't know if we want to keep the stuff that got placed in the lower left. I am fine with letting it go. The fewer customizations, the easier it is to maintain.
  • The title Plone Training 2023 documentation just below the logo no longer appears. We still need this, I just don't know where it should go yet.
  • Code blocks are illegible in dark mode.
  • Scroll-spy is gone. This is the feature when you scroll, the subnavigation highlights the current section.

Closes #533

@stevepiercy stevepiercy requested a review from ksuess April 2, 2023 11:06
@netlify
Copy link

netlify bot commented Apr 2, 2023

Deploy Preview for plone-training ready!

Name Link
🔨 Latest commit
🔍 Latest deploy log https://app.netlify.com/sites/plone-training/deploys/643524d6d967df2965e9bae7
😎 Deploy Preview https://deploy-preview-752--plone-training.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@stevepiercy
Copy link
Contributor Author

Update 2022-04-09

  • Fixed requirements to pull in the latest versions of everything. We need a clean canvas, and can build up from there.
  • Deleted a custom template docs/_templates/sections/header-article.html that appeared to do nothing. @ksuess or someone else might know its purpose, and if it is still needed, I can restore it.
  • Removed extra_navbar configuration as obsolete and redundant to new theme
  • Cleaned up a lot of broken links and references.
  • Fixed broken HTML meta tag formats on a few pages. Note that I will not add missing attributes for the hundreds of warnings, as that is the responsibility of the author who cares about SEO for their training. I would encourage authors to use HTML meta information to increase their business's exposure.

@stevepiercy stevepiercy changed the base branch from main to 2022 April 10, 2023 10:33
@stevepiercy stevepiercy mentioned this pull request Apr 10, 2023
19 tasks
@stevepiercy
Copy link
Contributor Author

It's all ready to review. w00t!

There is a slight bug, to set the default value "all trainings" for the filter. I'll fix that.

@stevepiercy
Copy link
Contributor Author

Slight bug is now fixed.

@fredvd
Copy link
Member

fredvd commented Apr 12, 2023

Only issue with the theme I could fine: viewing the trainings on tablet size the hamburger menu to remove the left table of contents doesn't work in portrait mode. (the pane with the plone logo at the top). If I hold my table horizontal, the folding of the pane does work. :-(

dark mode ❤️

@polyester polyester merged commit 0be8622 into 2022 Apr 12, 2023
@polyester polyester deleted the upgrade-theme branch April 12, 2023 15:09
@polyester polyester restored the upgrade-theme branch April 12, 2023 15:09
@stevepiercy
Copy link
Contributor Author

@fredvd can you replicate the issue on the site for the theme? https://sphinx-book-theme.readthedocs.io/en/stable/ If yes, then would you please open an issue with that theme? I think there is a range of breakpoints (952px-984px) where it does not work, but does work outside that range.

@stevepiercy
Copy link
Contributor Author

Actually I have opened an issue executablebooks/sphinx-book-theme#721. Thank you @fredvd

@stevepiercy stevepiercy deleted the upgrade-theme branch April 12, 2023 20:35
@stevepiercy stevepiercy mentioned this pull request Apr 12, 2023
@fredvd
Copy link
Member

fredvd commented Apr 13, 2023

Actually I have opened an issue executablebooks/sphinx-book-theme#721.

Yes, it happens on the offical theme page as well. Thanks for opening the issue there. Hadn't tested yet on desktop myself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add dark mode
3 participants