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

Version toggler and feedback dropdown look odd #497

Closed
amotl opened this issue May 28, 2024 · 19 comments
Closed

Version toggler and feedback dropdown look odd #497

amotl opened this issue May 28, 2024 · 19 comments
Assignees

Comments

@amotl
Copy link
Member

amotl commented May 28, 2024

@msbt reported a visual regression.

Quick FYI: I realized earlier that the version toggler and feedback dropdown on the docs look odd and while debugging, figured out that there was an update of one of the packages that we have in use (https://github.com/executablebooks/sphinx-design/tags). This update/regression caused the layout to fail.

image

@amotl
Copy link
Member Author

amotl commented May 28, 2024

@msbt figured the regression has been caused by sphinx-design-0.6.0, released just five days ago.

Other than investigating about which kind of changes to CSS rules might have caused the regression, he suggested to downgrade to sphinx-design<0.6 in the meanwhile, in order to work around that problem.

@msbt
Copy link
Collaborator

msbt commented May 28, 2024

thanks @amotl, this seems to be the corresponding patch, where they change from chevron up/down to right/down: executablebooks/sphinx-design#192

@amotl
Copy link
Member Author

amotl commented May 28, 2024

Thanks. I can't spot the regression you outlined at https://cratedb.com/docs/crate/reference/ and friends. May I ask you to elaborate where it is visible?

@msbt
Copy link
Collaborator

msbt commented May 28, 2024

@amotl
Copy link
Member Author

amotl commented May 28, 2024

I totally accept and appreciate that you spotted an error. However, it is not visible for me in any way. Maybe you can support this case by referring to a spot where we can also see it?

Within the OP, there is just a screenshot, but no reference to a corresponding spot.

@amotl
Copy link
Member Author

amotl commented May 28, 2024

I am asking because a downgrade to a previous version of sphinx-design would be totally a no-brainer, like outlined at #497 (comment).

However, because I can't spot any regression anywhere, I am doubting that it makes sense, because it will not make too much of a difference from my perspective.

@matkuliak
Copy link
Contributor

One thing to mention for anyone working on this, @msbt was able to patch this by injecting CSS with HubSpot - via fastly edge side includes, from what I understand.

@amotl
Copy link
Member Author

amotl commented May 28, 2024

Ah I see. Now it totally makes sense that I can't spot any mistake, if it has already been fixed using a workaround. Thanks for clarifying.

@msbt
Copy link
Collaborator

msbt commented May 28, 2024

@amotl you can see the regression on any non-proxied url, e.g. https://crash.readthedocs.io/en/latest/

So the padding changed and also the chevrons

@amotl
Copy link
Member Author

amotl commented May 28, 2024

Now, everything makes sense. Thanks for clarifying.

NB: Please don't use linkable URLs verbatim in public which can feed crawlers wrongly.

@amotl
Copy link
Member Author

amotl commented May 28, 2024

Because sphinx-design 0.6 also trips software tests on sphinx-design-elements, and because I currently don't have the capacity to review and fix them, I am already downgrading on behalf of sphinx-design-elements, release pending.

@amotl
Copy link
Member Author

amotl commented May 28, 2024

sphinx-design-elements v0.3.2 downgrades to sphinx-design v0.5, so the next downstream builds of crate-docs-theme should pick up corresponding package versions, effectively resolving this issue.

Please verify, report back, and/or close this issue, all at your disposal. Thanks.

@amotl
Copy link
Member Author

amotl commented May 28, 2024

@amotl
Copy link
Member Author

amotl commented Jun 17, 2024

@amotl you can see the regression on any non-proxied url, e.g. https://crash.readthedocs.io/en/latest/. The padding changed and also the chevrons.

It looks like it is fixed through the downgrading outlined above.

@amotl amotl closed this as completed Jun 17, 2024
@amotl
Copy link
Member Author

amotl commented Jun 18, 2024

I just found that in the changelog for sphinx-design 0.6:

The "default" behaviour of the right chevron is to go from right-facing (closed) to down-facing (open), instead of down-facing (closed) to up-facing (open). There is also a rotate transition on opening/closing. The old default behaviour can be retained by using the new :chevron: down-up directive option.

@amotl
Copy link
Member Author

amotl commented Jun 28, 2024

We concluded the resolution of this flaw by adding relevant fixes and releasing crate-docs-theme 0.33.0. @msbt: Thanks for your support!

@amotl amotl closed this as completed Jun 28, 2024
@msbt
Copy link
Collaborator

msbt commented Jul 1, 2024

@amotl apparently the docs are still being built with the old version (Downloading crate_docs_theme-0.32.4-py3-none-any.whl (2.1 MB)) - any idea what's going on there?

@amotl
Copy link
Member Author

amotl commented Jul 4, 2024

Build #24863053 on "crash" says it uses crate-docs-theme-0.33.0 already. If you can provide a reference to where it's different, I can look into it.

@msbt
Copy link
Collaborator

msbt commented Jul 4, 2024

@amotl that was back when the 0.33.0 wasn't on pyi

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

No branches or pull requests

3 participants