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

chore(docs): increase dark mode compatibility #2530

Merged
merged 2 commits into from
Feb 16, 2024

Conversation

mdt2
Copy link
Collaborator

@mdt2 mdt2 commented Feb 15, 2024

Description

Updating the pug templates to:

  • make the deprecationNotice part of the deprecation alert dark mode compatible
  • make links in the deprecationNotice and description fields dark mode compatible

How and where has this been tested?

Please tag yourself on the tests you've marked complete to confirm the tests have been run by someone other than the author.

Validation steps

  • In the docs site, go to Quick Actions and turn on dark mode. All text in the deprecation notice should be white other than the link (but the link should also be using dark mode colors)
  • Go to Accordion, scroll down to the Custom Properties API section. With dark mode on, the link should be dark mode compatible

Regression testing

Validate:

  1. The documentation pages for at least two other components are still loading, including:
  • The pages render correctly, are accessible, and are responsive.
  1. If components have been modified, VRTs have been run on this branch:
  • VRTs have been run and looked at.
  • Any VRT changes have been accepted (by reviewer and/or PR author), or there are no changes.

Screenshots

To-do list

  • I have read the contribution guidelines.
  • I have updated relevant storybook stories and templates.
  • I have tested these changes in Windows High Contrast mode.
  • If my change impacts other components, I have tested to make sure they don't break.
  • If my change impacts documentation, I have updated the documentation accordingly.
  • ✨ This pull request is ready to merge. ✨

Copy link
Contributor

github-actions bot commented Feb 15, 2024

File metrics

Summary

Total size: 3.94 MB*

🎉 No changes detected in any packages

* Size determined by adding together the size of the main file for all packages in the library.
* Results are not gzipped or minified.
* An ASCII character in UTF-8 is 8 bits or 1 byte.

Copy link
Contributor

github-actions bot commented Feb 15, 2024

🚀 Deployed on https://pr-2530--spectrum-css.netlify.app

@mdt2 mdt2 changed the title chore(docs): deprecationNotice is dark mode compatible chore(docs): increase dark mode compatibility Feb 15, 2024
@mdt2 mdt2 force-pushed the mdt2/fix-deprecation-notice-dark-mode branch from cd93b99 to c692668 Compare February 16, 2024 14:16
@castastrophe castastrophe added skip_vrt Add to a PR to skip running VRT (but still pass the action) ready-for-review documentation Because documentation is important and shouldn't be broken labels Feb 16, 2024
@mdt2 mdt2 force-pushed the mdt2/fix-deprecation-notice-dark-mode branch from c692668 to 8ec7863 Compare February 16, 2024 15:21
@castastrophe castastrophe merged commit 593374c into main Feb 16, 2024
10 checks passed
@castastrophe castastrophe deleted the mdt2/fix-deprecation-notice-dark-mode branch February 16, 2024 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Because documentation is important and shouldn't be broken ready-for-review skip_vrt Add to a PR to skip running VRT (but still pass the action)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants