Closed nikkimk closed 1 week ago
When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:
If the changes are expected, update the current_golden_images_cache
hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.
Category | Latest (report) | Main (report) | Branch (report) |
---|---|---|---|
Performance | 0.98 | 0.99 | 0.99 |
Accessibility | 1 | 1 | 1 |
Best Practices | 1 | 1 | 1 |
SEO | 1 | 0.92 | 0.92 |
PWA | 1 | 1 | 1 |
main
("Main"). Higher scores are better, but *note that the SEO scores on Netlify URLs are artifically constrained to 0.92.*
Category | Latest | Main | Branch |
---|---|---|---|
Total | 251.551 kB | 236.975 kB π | 237.043 kB |
Scripts | 61.28 kB | 54.296 kB | 54.073 kB π |
Stylesheet | 53.973 kB | 48.197 kB π | 48.331 kB |
Document | 6.242 kB | 5.508 kB π | 5.534 kB |
Font | 127.013 kB | 126.624 kB π | 126.756 kB |
Category | Latest | Main | Branch |
---|---|---|---|
Total | 52 | 52 | 52 |
Scripts | 41 | 41 | 41 |
Stylesheet | 5 | 5 | 5 |
Document | 1 | 1 | 1 |
Font | 2 | 2 | 2 |
!!! NOTE TO REVIEWERS !!!
Please only review the docs listed in How has this been tested? section.
When this PR is reviewed, it will be merged into #4756, where all of the changes will be reviewed before merging into main.
Please place any other feedback in #4756
Description
Improving the accessibility documentation of components.
Related issue(s)
4756
Motivation and context
Documentation should provide more information and examples that demonstrate how to use the components accessibly.
How has this been tested?
Overview tabs navigation fix
https://nikkimk-a11y-docs-turkey-trot--spectrum-web-components.netlify.app/components/card/
?https://nikkimk-a11y-docs-turkey-trot--spectrum-web-components.netlify.app/components/card/
?Accessibility headings of previously updated docs
Some of the docs that have already been merged in #4756 had inconsistent headings for their accessibility sections. Go to the following docs and make sure that the heading is "Accessibility" not "Accessibility guidelines":
<sp-card>
Review card docs
<sp-slider>
Review slider docs
<sp-slider-handle>
Review slider handle docs
<sp-switch>
Review switch docs
1. You can use the WAVE browser extension's Structure tab to review heading structure.
Types of changes
Checklist
Best practices
This repository uses conventional commit syntax for each commit message; note that the GitHub UI does not use this by default so be cautious when accepting suggested changes. Avoid the "Update branch" button on the pull request and opt instead for rebasing your branch against
main
.