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

feat: Implement SDS admonitions for docs site #1401

Merged
merged 5 commits into from
Jan 17, 2025

Conversation

@dgmccart
Copy link
Collaborator

The callouts aren't readable in dark mode. Can we implement a color change for the text?

Screenshot 2024-12-13 at 5 52 08 PM Screenshot 2024-12-13 at 5 55 20 PM

@dgmccart
Copy link
Collaborator

Also, could we change the styling on the example page from blue callouts to the accordion styling used in the FAQ page? With that change, please also update the color of the callouts on the napari page to the blue that is from the current examples callouts.

@melissawm
Copy link
Collaborator Author

@dgmccart to clarify - we want to use the blue from the theme, instead of the blue from sds?

Current blue (from sphinx-immaterial theme):
Screenshot 2024-12-16 at 10 19 55 AM

SDS blue (recommended by Kevin, see https://sds.czi.design/009eaf17b/p/72e266-callouts)
Screenshot 2024-12-16 at 10 20 10 AM

@dgmccart
Copy link
Collaborator

Good catch - use the SDS blue please.

@melissawm
Copy link
Collaborator Author

I've updated the PR with the requested changes. Maybe I am missing something but I didn't find any details on how to use admonitions for dark mode in SDS - so I kept them as-is. Let me know if this should be changed. I don't know if I like them, to be honest 😅

Some examples:

Screenshot 2025-01-09 at 3 08 48 PM Screenshot 2025-01-09 at 3 08 56 PM Screenshot 2025-01-09 at 3 09 06 PM

Full Preview: https://melissawm.github.io/cryoet-data-portal/cryoet_data_portal_docsite_examples.html#examples

@dgmccart
Copy link
Collaborator

dgmccart commented Jan 9, 2025

@kev-zunshiwang could you do a quick review of the dark mode implementation to see if it is acceptable?

@kev-zunshiwang
Copy link
Collaborator

kev-zunshiwang commented Jan 14, 2025

Hey Melissa, some spec feedback for the callout component below:

  • round all 4 corners by 4px.
  • bold the title to font-weight: 600
  • padding all around should be 12px
  • padding between title and paragraph should be 4px.
  • for the code background color inside the callout use gray100 (#F3F3F3)

@kev-zunshiwang
Copy link
Collaborator

Some feedback for the accordion component:

  • bold the questions using font-weight 600
  • change the caret color to #6C6C6C

@kev-zunshiwang
Copy link
Collaborator

Dark mode for callout component:
I checked in with Connor that we have dark mode variant for the callout components. It doesn't seem to reflect properly on the website

You can reach out to #sci-design-system-support and Timmy or Masoud will hop in for help!

@dgmccart
Copy link
Collaborator

You can reach out to #sci-design-system-support and Timmy or Masoud will hop in for help!

@melissawm Let me know if you need help reaching out to them.

@melissawm
Copy link
Collaborator Author

Hi all - I did not have the correct link to SDS. Looking at the links in the channel linked above I found the correct repo for SDS and I can see the dark mode recommendations: https://chanzuckerberg.github.io/sci-components/?path=/story/components-callout--default&globals=theme:dark

Thanks!!

@melissawm
Copy link
Collaborator Author

Hi folks, I think I got everything now. See screenshots below.

Screenshot 2025-01-17 at 3 35 32 PM Screenshot 2025-01-17 at 3 35 43 PM Screenshot 2025-01-17 at 3 36 07 PM Screenshot 2025-01-17 at 3 36 17 PM Screenshot 2025-01-17 at 3 53 08 PM

@dgmccart dgmccart self-requested a review January 17, 2025 19:12
@dgmccart
Copy link
Collaborator

LGTM!

@dgmccart dgmccart merged commit b211efc into chanzuckerberg:main Jan 17, 2025
3 checks passed
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.

Docs: Eng / Design Improvements for 2024
3 participants