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

Documentation and MR template updates relating to light mode #303

Merged
merged 2 commits into from
Jul 30, 2024

Conversation

helenb
Copy link
Member

@helenb helenb commented Jul 29, 2024

Link to Ticket

Description of Changes Made

  • Update MR template to add a note about checking both dark and light mode (I have also updated the list on the Monday ticket template)
  • Update the docs to add details about the dark and light mode functionality
  • Added clarifying comments to the high contrast light and dark mode mixins to explain that these do not relate to the dark and light mode functionality

How to Test

Screenshots

Expand to see more

MR Checklist

  • Add a description of your pull request and instructions for the reviewer to verify your work.
  • If your pull request is for a specific ticket, link to it in the description.
  • Stay on point and keep it small so the merge request can be easily reviewed.
  • Tests and linting passes.

Unit tests

  • Added
  • Not required

Documentation

Browser testing

  • I have tested in the following browsers and environments (edit the list as required)
    • Latest version of Chrome on mac
    • Latest version of Firefox on mac
    • Latest version of Safari on mac
    • Safari on last two versions of iOS
    • Chrome on last two versions of Android
  • Not required

Data protection

  • Not relevant
  • This adds new sources of PII and documents it and modifies Birdbath processors accordingly

Accessibility

  • Automated WCAG 2.1 tests pass
  • HTML validation passes
  • Manual WCAG 2.1 tests completed
  • I have tested in a screen reader
  • I have tested in high-contrast mode
  • Any animations removed for prefers-reduced-motion
  • Not required

Sustainability

  • Images are optimised and lazy-loading used where appropriate
  • SVGs have been optimised
  • Perfomance and transfer of data considered
  • If JavaScript is needed alternatives have been considered
  • Not required

Pattern library

  • The pattern library component for this template displays correctly, and does not break parent templates
  • The styleguide is updated if relevant
  • Changes are not relevant the pattern library


## Cloudflare workers

In order to avoid cloudflare caching an incorrect version of a page, we use some custom cloudflare workers to ensure that both versions of the page are cached, and the user's preference respected.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@RealOrangeOne feel free to improve this wording!

@helenb helenb requested a review from chris-lawton July 30, 2024 07:04
@helenb helenb merged commit 9c6e520 into main Jul 30, 2024
2 checks passed
@helenb helenb deleted the chore/light-mode-docs branch July 30, 2024 11:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant