Skip to content

Commit 47c711a

Browse files
committed
various text updates
1 parent 70ce39c commit 47c711a

File tree

6 files changed

+84
-335
lines changed

6 files changed

+84
-335
lines changed

docs/accessibility/configuration/axe-core-configuration.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
Configuration for Axe-Core® rules is available through your Account Executive. We we are happy to have a call with you to dial in your report config to make sure you are getting the most useful reports possible, and we find this onboarding very effective.
66

7-
Generally configuration of these rules isn't needed because your implementation of any policies about what should "fail a build" is handled using the [results-api.md](/accessibility/results-api), where you have full control over how to parse the results and what rules need to be reacted to. Keeping the results in Cypress Cloud broad helps you to still be able to see and understand all of the accessibility information, even if only a subset of the results would be considered blocking.
7+
In most cases, configuration of these rules as they run in Cypress Cloud isn't needed, because your implementation of any policies about what should "fail a build" is handled using the [Accessibility Results API](/accessibility/results-api), where you have full control over how to parse the results and what rules need to be reacted to. Keeping the results in Cypress Cloud broad helps you to still be able to see and understand all of the accessibility information, even if only a subset of the results would be considered blocking.
88

9-
**Note.** Certain Axe Core rules are off by default. Here are the rules that are currently either ignored by configuration, or for which results cannot be detected.
9+
**Note.** Certain Axe Core® rules are off by default. Here are the rules that are currently either ignored by configuration, or for which results cannot be detected.
1010

1111
- `Elements must meet minimum color contrast ratio thresholds`
12-
- This is off by default. This is both the slowest rule in the Axe Core ruleset, and the one that can have the highest percentage of false positives or incomplete checks.
12+
- This is off by default. This is both the slowest rule in the Axe Core® ruleset, and the one that can have the highest percentage of false positives or incomplete checks.
1313
- It does work perfectly in many projects, so we are happy to turn this on for you if requested, so that you can see the results.
1414
- `<video> or <audio> elements must not play automatically`
1515
- Ignored because Test Replay does not yet capture the metadata to check this

docs/accessibility/core-concepts/accessibility-score.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ sidebar_position: 30
1111

1212
Cypress produces a top-line percentage score that indicates a general sense of accessibility for a project. This overall score for a run is based on the **average score of** **all application snapshots** that were captured during the run, and is rooted in the ratio of passing and failing accessibility checks performed on each snapshot, weighted according to the severity of the issues.&#x20;
1313

14-
The severity levels presented in Cypress Cloud match the Axe Core `impact` level for each rule. This impact classification was developed by the creators of Axe, Deque Systems, to aid in prioritization of accessibility results, by highlighting rules that are likely to reveal the most substantial barriers (such as missing label text) so they can be addressed first.
14+
The severity levels presented in Cypress Cloud match the Axe Core® `impact` level for each rule. This impact classification was developed by the creators of Axe, Deque Systems, to aid in prioritization of accessibility results, by highlighting rules that are likely to reveal the most substantial barriers (such as missing label text) so they can be addressed first.
1515

16-
It's important to note that the Web Content Accessibility Guidelines (WCAG) standards do not have a concept of relative severity of the Success Criteria. For **compliance** purposes, all failures of the Success Criteria count and must be addressed. For **usability** purposes, however, the impact values provided by Axe Core provide excellent guidance about which issues to take up first to bring the most benefit to disabled users of your plaform as quickly as possible.
16+
It's important to note that the Web Content Accessibility Guidelines (WCAG) standards do not have a concept of relative severity of the Success Criteria. For **compliance** purposes, all failures of the Success Criteria count and must be addressed. For **usability** purposes, however, the impact values provided by Axe Core® provide excellent guidance about which issues to take up first to bring the most benefit to disabled users of your plaform as quickly as possible.
1717

1818
## Algorithm
1919

docs/accessibility/core-concepts/run-level-reports.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,20 +54,20 @@ An overall score is calculated based on all the Snapshots for a given View. The
5454
The count of elements in a view that failed a Rule, had an inconclusive check for a Rule, or were explicitly ignored by configuration.
5555

5656
- **Failed** elements had at least one accessibility Rule fail during the run. These are considered in your accessibility Score and must be fixed.&#x20;
57-
- **Inconclusive** elements had at least one check marked "incomplete" by Axe Core during the run. These represent checks that couldn't be completed for technical reasons, or items that need manual review to confirm if there is an accessibility issue. These do not affect your score.
57+
- **Inconclusive** elements had at least one check marked "incomplete" by Axe Core® during the run. These represent checks that couldn't be completed for technical reasons, or items that need manual review to confirm if there is an accessibility issue. These do not affect your score.
5858
- **Ignored** elements are those that had either failing or incomplete checks, but were ignored with [CSS selectors in your configuration](/accessibility/configuration/elementfilters). They do not affect your score. Cypress still processes these elements and makes the results available, so that you always know results were was ignored, since these elements are still present in your UI and users will encounter them.
5959

6060
#### Failed rules
6161

62-
Failed rules are broken down for each View with a mini chart displaying Axe Core severity levels, as well as a total count for failed rules. Both of these help you identify at a glance which pages or components have high numbers serious issues.
62+
Failed rules are broken down for each View with a mini chart displaying Axe Core® severity levels, as well as a total count for failed rules. Both of these help you identify at a glance which pages or components have high numbers serious issues.
6363

6464
#### Severity
6565

6666
In Cypress Accessibility, severity levels are mapped to Axe Core's `impact` level for each rule. It's important to note that these levels were created by Deque Systems, the creators of Axe Core, and not a part of the Web Content Accessibility Guidelines themselves. For more details on this, see our [accessibility score documentation](https://github.com/dequelabs/axe-core/blob/develop/doc/issue_impact.md).
6767

6868
## Rules
6969

70-
This section lists the outcome of every Axe Core rule that was enabled at the time of this run.
70+
This section lists the outcome of every Axe Core® rule that was enabled at the time of this run.
7171

7272
<DocsImage
7373
src="/img/accessibility/core-concepts/cypress-accessibility-rules-list.png"
@@ -81,11 +81,11 @@ Each Rule in the table has the following attributes:
8181
- An icon representing the overall status for the rule, which can be any one of these:
8282
- **Passed** -- every time this rule applied to an element, the element either passed that rule's checks or was intentionally ignored
8383
- **Failed** -- at least one failing element was detected in the run
84-
- **Inconclusive** -- no elements failed this rule, but at least one element was labelled "incomplete" by Axe Core and requires manual review
84+
- **Inconclusive** -- no elements failed this rule, but at least one element was labelled "incomplete" by Axe Core® and requires manual review
8585
- **Inapplicable** -- this rule was enabled during the run, but there were no elements detected that required the rule to run
8686
- **Ignored by config** -- this rule was ignored at the config level for the project and did not run
8787
- The description for the rule
88-
- The Axe Core severity level for the rule
88+
- The Axe Core® severity level for the rule
8989
- The counts of failed, inconclusive, and ignored elements for each rule
9090

9191
## Filtering

docs/accessibility/get-started/introduction.mdx

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
---
22
sidebar_label: Introduction
33
title: 'Introduction'
4-
description: 'Cypress Accessibility provides organized, visual, and actionable accessibility reports, based completely on the tests you record to Cypress Cloud, and powered by Axe Core by Deque Systems.'
4+
description: 'Cypress Accessibility provides organized, visual, and actionable accessibility reports, based completely on the tests you record to Cypress Cloud, and powered by Axe Core® by Deque Systems.'
55
sidebar_position: 10
66
---
77

88
# Cypress Accessibility
99

1010
<AccessibilityAddon />
1111

12-
Cypress Accessibility provides organized, visual, and actionable accessibility reports, based completely on the tests you record to Cypress Cloud, and powered by Axe Core by Deque Systems.
12+
Cypress Accessibility provides organized, visual, and actionable accessibility reports, based completely on the tests you record to Cypress Cloud, and powered by Axe Core® by Deque Systems.
13+
14+
To learn about the general topic of accessibility testing using the Cypress App, see [our guide on this topic](/app/guides/accessibility-testing).
1315

1416
<DocsImage
1517
src="/img/accessibility/get-started/cypress-accessibility-overview.png"
@@ -26,10 +28,20 @@ Reports are generated using the industry-standard open source [Axe Core](https:/
2628

2729
## Understanding what is tested
2830

29-
Axe Core checks for accessibility violations in your website's user interface, based on common accessibility standards. A violation detected by Axe usually indicates that some users with disabilities would have a problem using or perceiving a feature. An example of a violation would be an image without alternative text provided in the markup, which means the content is not perceivable to visually-impaired users. [Learn more about Axe.](https://github.com/dequelabs/axe-core)
31+
Axe Core® checks for accessibility violations in your website's user interface, based on common accessibility standards. A violation detected by Axe usually indicates that some users with disabilities would have a problem using or perceiving a feature. An example of a violation would be an image without alternative text provided in the markup, which means the content is not perceivable to visually-impaired users. [Learn more about Axe.](https://github.com/dequelabs/axe-core)
3032

3133
Axe reaches a high standard for automated testing, but cannot test every possible aspect of compliance, especially for heavily custom interfaces or aspects requiring human judgment. Please note that a 100% axe score does not mean all possible accessibility errors have been ruled out. [Axe typically detects up to 57% of the issues that would appear in a manual accessibility audit.](https://www.deque.com/blog/automated-testing-study-identifies-57-percent-of-digital-accessibility-issues/)
3234

33-
##### Trademark notice
35+
## Highlights
36+
37+
* All steps of all user flows tested in Cypress are captured automatically
38+
* Server-side execution means no disruption to existing test code or practices, and no performance impact
39+
* Reports are generated at the page or component level, as well as a combined report showing the outcome of all accessibility rules checked in the run
40+
* Debuggable full-page DOM snapshots with highlights are provided for every violation
41+
* Iframes and Shadow DOM are supported out-of-the-box
42+
* The Results API allows you to own how your CI pipeline reacts to the accessibility results of the run to implement a policy
43+
* "Ignored" elements are isolated and don't affect your score, but can still be reviewed
44+
45+
### Trademark notice
3446

3547
_Note: DEQUE, DEQUELABS, AXE®, and AXE-CORE® are trademarks of Deque Systems, Inc. in the US and other countries._

docs/app/get-started/why-cypress.mdx

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ of your test suite and the quality of your application.
2929

3030
- [Cypress App](/app/core-concepts/open-mode), a free,
3131
[open source](https://github.com/cypress-io/cypress),
32-
locally installed app.
32+
locally installed app for writing and running tests.
3333
- [Cypress Cloud](/cloud/get-started/introduction), a paid service for recording tests, surfacing test results, and providing test analytics.
3434
- [UI Coverage](/ui-coverage/get-started/introduction), a paid add-on providing a visual overview of test coverage across every page and component of your app, offering clear insights into uncovered areas that everyone can understand.
35-
- [Cypress Accessibility](/accessibility/get-started/introduction), a paid add-on providing accessibility checks to ensure your application is accessible to all users.
35+
- [Cypress Accessibility](/accessibility/get-started/introduction), a paid add-on providing accessibility checks, which helps detect barriers for people with disabilities using your application.
3636

3737
Cypress is a robust solution that can improve the quality of your application.
3838

@@ -43,8 +43,7 @@ Cypress is a robust solution that can improve the quality of your application.
4343
CI Provider, [Cypress Cloud](/cloud/get-started/introduction) can record your test
4444
runs surfacing exactly what happened during the test in [Test Replay](/cloud/features/test-replay).
4545
You'll never have to wonder: _Why did this fail?_
46-
- **Finally:** Add on [Cypress Accessibility](/accessibility/get-started/introduction) to ensure your application is
47-
accessible to all users and [UI Coverage](/ui-coverage/get-started/introduction) to ensure you've tested
46+
- **Finally:** Add on [Cypress Accessibility](/accessibility/get-started/introduction) to get continuous feedback on accessibility issues and regressions, and [UI Coverage](/ui-coverage/get-started/introduction) to ensure you've tested
4847
every part of your application.
4948

5049
## Features
@@ -210,8 +209,8 @@ it('adds a todo', () => {
210209

211210
### Accessibility Testing
212211

213-
You can write Cypress tests to check the accessibility of your application.
214-
When combined with [Cypress Accessibility](/accessibility/get-started/introduction), insights can be surfaced when
212+
You can write Cypress tests to check the accessibility of your application, and use plugins to run broad accessibility checks.
213+
When combined with [Cypress Accessibility](/accessibility/get-started/introduction) in Cypress Cloud, insights can be surfaced when specific
215214
accessibility standards are not met through your testing - with no configuration required.
216215

217216
```js

0 commit comments

Comments
 (0)