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

MAINT - Style fixes following design system implementation #1387

Closed
4 tasks done
trallard opened this issue Jul 13, 2023 · 6 comments
Closed
4 tasks done

MAINT - Style fixes following design system implementation #1387

trallard opened this issue Jul 13, 2023 · 6 comments
Assignees
Labels
kind: maintenance Improving maintainability and reducing technical debt tag: accessibility Issues related to accessibility issues or efforts

Comments

@trallard
Copy link
Collaborator

trallard commented Jul 13, 2023

I am opening this issue as a way to track little nags here and there that were missed through some of the accessibility-related PRs merged recently (i.e., #1174 and #1353)

Note
Click on the "Sample images" expandable component to see sample screenshots

If anyone encounters other nags, feel free to add to this issue or conversation 🙌🏽 feedback is always welcome!

Identified nags

  • Option lists style should align with inline code style

    Sample images

    Inline code styling:
    Theme_Structure_and_Layout_—_PyData_Theme_documentation

    Option lists styling:
    Lists_—_PyData_Theme_documentation

  • Table of Contents: fix the link underline decoration so that it is not applied to the gap between the icon and text

    Sample images

    Table of contents icon + link:
    Admonitions_—_PyData_Theme_documentation

    An icon + link example in text:
    Generic_items_—_PyData_Theme_documentation

  • Fix focus visible state of clickable cards - currently, the focus-visible box only appears around the bottom of the card

    Sample images

    Sphinx_Design_Components_—_PyData_Theme_documentation - Clickable card focused through keyboard

  • Light theme only: Fix colour contrast for links on deprecation admonitions (should be fixed by using the same shade of teal as we do in the inline code links --pst-color-inline-code-links) - also note for @trallard to check: version added and version changed variants

    Sample images

    Colour_Contrast_Analyser__CCA__and_Branding_and_logo_—PyData_Theme_documentation_and_New_Issue·_pydata_pydata-sphinx-theme

@trallard trallard self-assigned this Jul 13, 2023
@trallard trallard added tag: accessibility Issues related to accessibility issues or efforts kind: maintenance Improving maintainability and reducing technical debt labels Jul 13, 2023
@jorisvandenbossche
Copy link
Member

Another detail that I noticed:

The version dropdown is using a blue color for highlighting the "currently selected" version, while I would expect it to use the primary teal for that? (since other navigation elements use that for the current section):

Screenshot from 2023-07-13 13-19-24

(although inspecting with the browser, I see the color that is being used for this in the dropdown is --pst-color-info, so that's maybe intentional?)

@trallard
Copy link
Collaborator Author

Thanks @jorisvandenbossche - I remember seeing this and leaving the colour as it was defined. But I agree it would be best to align with the rest of the theme's styles.

@drammock
Copy link
Collaborator

agree, that is a mistake, it should be --pst-color-primary. Personally I also find it confusing to have "stable" highlighted in green (regardless of whether you're viewing stable docs or not) and would like to revisit that decision.

@trallard
Copy link
Collaborator Author

I am not sure if there is some historical reason for the stable version to be differentiated. But as the current style is; it is confusing and does break our current approach to indicate current/active items.

Also if the version warning banners get implemented these would provide a more visible way to signal folks are not on the stable version of the docs.

@trallard
Copy link
Collaborator Author

trallard commented Aug 3, 2023

Adding more info here for completeness, it seems that something changed between the last batch of comments and what is currently in our main branch:

  • now we have a mismatch between naming latest vs dev these should be identical to avoid confusion
  • the blue colour from dev was removed so there is no indicator that this is the current selection

@gabalafou
Copy link
Collaborator

gabalafou commented Nov 15, 2023

Fix focus visible state of clickable cards - currently, the focus-visible box only appears around the bottom of the card

Once #1549 is merged to main (it's currently merged into a feature branch), this will be fixed

@trallard trallard closed this as completed Jun 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: maintenance Improving maintainability and reducing technical debt tag: accessibility Issues related to accessibility issues or efforts
Projects
None yet
Development

No branches or pull requests

4 participants