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 flash of unstyled content in userguide #2842

Merged
merged 2 commits into from
Apr 19, 2020

Conversation

jreklund
Copy link
Contributor

sphinx_rtd_theme v0.4.3 have flash of unstyled content (FOUC) problems.

  • Removed + next to the navigation to mitigate left to right jumping in navigation
  • Changed rendering depth to 2, like userguide v3
  • Included a complete replacement of layout.html to be able to mitigate FOUC, by moving CSS above JS.

We still have problems with top to bottom jumping in navigation, due to the length of our navigation. That's not something that can be easily fixed as that's bundled JS with the theme. As per v3 userguide you need to scroll down to the current menu item. In v4 it jumps down to the selected one, giving better UX. That's what causing that jump.

This FOUC are included in the development branch of sphinx_rtd_theme, but as per previous discussions no one knows when they will release a new version (with Sphinx 2 support as well). And due to the nature of the problem, I choose to bundle this fix. As it's to critical for the UX.

PS. Forgot to include [ci skip] ...

Checklist:

  • Securely signed commits
  • User guide updated
  • Conforms to style guide

@jreklund
Copy link
Contributor Author

jreklund commented Apr 18, 2020

@lonnieezell Here are the fix for UX problems reported in the forum. Also made a design suggestion that we should limit .wy-nav-content instead, to get another color to brake the content out of the page. Like the theme original does it.

Demo at: https://codeigniter.johaneklund.com/userguide/latest/
Design at: https://codeigniter.johaneklund.com/userguide/master/

@lonnieezell
Copy link
Member

@jreklund I like limiting it that way and bringing out the grey also. Good changes. Thanks for tracking these down!

At least if we want to make changes it's simpler now since the layout is in one place. :)

@lonnieezell lonnieezell merged commit f913b58 into codeigniter4:develop Apr 19, 2020
@jreklund jreklund deleted the ug-fouc branch April 19, 2020 12:58
@lonnieezell
Copy link
Member

@jreklund I'm trying to find our conversation about the javascript solution for the ads on the UG but not having any luck. Do you remember which thread that exists on? Thanks!

@jreklund
Copy link
Contributor Author

@lonnieezell Hi, it's in PR #2671.

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.

2 participants