From 62d333e12c0b81d18f9aa62f4a6e5aee0d595e31 Mon Sep 17 00:00:00 2001 From: Jennifer Shehane Date: Thu, 26 Dec 2024 12:25:54 -0500 Subject: [PATCH 01/20] Add top guides section to a11y intro --- .../configuration/_category_.json | 2 +- .../get-started/introduction.mdx | 54 +++++++++++++++++++ docs/accessibility/guides/_category_.json | 2 +- .../guides/accessibility-automation.mdx | 7 ++- ...l-requests.mdx => block-pull-requests.mdx} | 6 ++- ...sibility.mdx => improve-accessibility.mdx} | 8 ++- docs/accessibility/guides/introduction.mdx | 12 ++--- .../guides/local-development.mdx | 4 +- ...ibility.mdx => maintain-accessibility.mdx} | 6 ++- ...ing-coverage.mdx => maximize-coverage.mdx} | 6 ++- .../guides/production-monitoring.mdx | 6 ++- src/css/custom.scss | 47 +++++++++++++++- src/theme/MDXComponents.js | 20 ++++++- 13 files changed, 162 insertions(+), 18 deletions(-) rename docs/accessibility/guides/{blocking-pull-requests.mdx => block-pull-requests.mdx} (90%) rename docs/accessibility/guides/{improving-accessibility.mdx => improve-accessibility.mdx} (95%) rename docs/accessibility/guides/{maintaining-accessibility.mdx => maintain-accessibility.mdx} (96%) rename docs/accessibility/guides/{maximizing-coverage.mdx => maximize-coverage.mdx} (87%) diff --git a/docs/accessibility/configuration/_category_.json b/docs/accessibility/configuration/_category_.json index ff6e7ca250..7f8cb5b6d7 100644 --- a/docs/accessibility/configuration/_category_.json +++ b/docs/accessibility/configuration/_category_.json @@ -1,4 +1,4 @@ { "label": "Configuration", - "position": 30 + "position": 40 } diff --git a/docs/accessibility/get-started/introduction.mdx b/docs/accessibility/get-started/introduction.mdx index e4e1f1ae81..a550072c14 100644 --- a/docs/accessibility/get-started/introduction.mdx +++ b/docs/accessibility/get-started/introduction.mdx @@ -44,6 +44,60 @@ From there, you can integrate with CI to set your own standards for handling the [Get started with Cypress Accessibility ➜](/accessibility/get-started/setup) +## Top Guides + + + ## How it Works 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. This is the documentation page for that product. To learn about the general topic of accessibility testing using the Cypress App, see [our guide on this topic](/app/guides/accessibility-testing). diff --git a/docs/accessibility/guides/_category_.json b/docs/accessibility/guides/_category_.json index 371eacc4b7..c9532523a7 100644 --- a/docs/accessibility/guides/_category_.json +++ b/docs/accessibility/guides/_category_.json @@ -1,4 +1,4 @@ { "label": "Guides", - "position": 70 + "position": 30 } diff --git a/docs/accessibility/guides/accessibility-automation.mdx b/docs/accessibility/guides/accessibility-automation.mdx index c1b6565503..c4aa325953 100644 --- a/docs/accessibility/guides/accessibility-automation.mdx +++ b/docs/accessibility/guides/accessibility-automation.mdx @@ -1,8 +1,13 @@ --- -title: Accessibility automation principles +sidebar_label: Accessibility automation principles +title: 'Accessibility automation principles | Cypress Accessibility Documentation' +description: " +Apply these core principles to maximize the impact of Cypress Accessibility’s automation: complement automation with human judgment for deeper insights, manage false positives effectively, and ensure robust assistive technology support." sidebar_position: 80 --- +# Accessibility automation principles + This guide describes some general ideas that are relevant to Cypress Accessibility, but are also somewhat shared among accessibility automation tools of any kind. ## What it means to fix all Axe Core® violations {#what-it-means-to-fix-all-axe-core-violations} diff --git a/docs/accessibility/guides/blocking-pull-requests.mdx b/docs/accessibility/guides/block-pull-requests.mdx similarity index 90% rename from docs/accessibility/guides/blocking-pull-requests.mdx rename to docs/accessibility/guides/block-pull-requests.mdx index 2b4fd92b51..0627d0c6d8 100644 --- a/docs/accessibility/guides/blocking-pull-requests.mdx +++ b/docs/accessibility/guides/block-pull-requests.mdx @@ -1,8 +1,12 @@ --- -title: Blocking pull requests and setting policies +sidebar_label: Block pull requests and set policies +title: 'Block pull requests and set policies | Cypress Accessibility Documentation' +description: "Set policies and block pull requests automatically with Cypress Accessibility's Results API, enabling custom CI workflows to enforce accessibility standards and prevent regressions." sidebar_position: 40 --- +# Block pull requests and set policies + Cypress Accessibility reports are generated on the server in Cypress Cloud, based on artifacts uploaded by the test runs. Because of this, there is no impact to your actual Cypress test execution, in terms of performance or anything else - including failing the Cypress run due to accessibility violations. ## Using the Results API diff --git a/docs/accessibility/guides/improving-accessibility.mdx b/docs/accessibility/guides/improve-accessibility.mdx similarity index 95% rename from docs/accessibility/guides/improving-accessibility.mdx rename to docs/accessibility/guides/improve-accessibility.mdx index ecbf2b27c3..59ce9bdce0 100644 --- a/docs/accessibility/guides/improving-accessibility.mdx +++ b/docs/accessibility/guides/improve-accessibility.mdx @@ -1,8 +1,12 @@ --- -title: Improving accessibility +sidebar_label: Improve accessibility +title: 'Improve Accessibility | Cypress Accessibility Documentation' +description: 'Discover how to break down accessibility reports, prioritize fixes, and make impactful progress toward accessible software with Cypress Accessibility.' sidebar_position: 20 --- +# Improve accessibility + In this section we'll discuss how to break down the data in your accessibility report and make a plan for remediation. Date: Thu, 26 Dec 2024 12:29:37 -0500 Subject: [PATCH 02/20] lint --- .../get-started/introduction.mdx | 59 ++++++++++++++----- .../guides/maximize-coverage.mdx | 2 +- .../guides/production-monitoring.mdx | 2 +- 3 files changed, 47 insertions(+), 16 deletions(-) diff --git a/docs/accessibility/get-started/introduction.mdx b/docs/accessibility/get-started/introduction.mdx index a550072c14..4f09c70020 100644 --- a/docs/accessibility/get-started/introduction.mdx +++ b/docs/accessibility/get-started/introduction.mdx @@ -47,53 +47,84 @@ From there, you can integrate with CI to set your own standards for handling the ## Top Guides diff --git a/docs/accessibility/guides/maximize-coverage.mdx b/docs/accessibility/guides/maximize-coverage.mdx index afb618816a..db6752bf43 100644 --- a/docs/accessibility/guides/maximize-coverage.mdx +++ b/docs/accessibility/guides/maximize-coverage.mdx @@ -1,7 +1,7 @@ --- sidebar_label: Maximize coverage title: 'Maximize coverage | Cypress Accessibility Documentation' -description: "Expand accessibility testing by combining Cypress Accessibility’s automated checks with custom assertions tailored to your application, identifying hotspots for deeper manual review, and ensuring long-term quality with a hybrid testing approach." +description: 'Expand accessibility testing by combining Cypress Accessibility’s automated checks with custom assertions tailored to your application, identifying hotspots for deeper manual review, and ensuring long-term quality with a hybrid testing approach.' sidebar_position: 70 --- diff --git a/docs/accessibility/guides/production-monitoring.mdx b/docs/accessibility/guides/production-monitoring.mdx index 356446b657..0cbab98d18 100644 --- a/docs/accessibility/guides/production-monitoring.mdx +++ b/docs/accessibility/guides/production-monitoring.mdx @@ -1,7 +1,7 @@ --- sidebar_label: Production monitoring title: 'Production monitoring | Cypress Accessibility Documentation' -description: "Monitor accessibility issues in production by running scheduled Cypress tests against live environments, capturing dynamic content changes, and generating automated reports for a comprehensive accessibility overview." +description: 'Monitor accessibility issues in production by running scheduled Cypress tests against live environments, capturing dynamic content changes, and generating automated reports for a comprehensive accessibility overview.' sidebar_position: 60 --- From 3ff228707afa9d158cdb40c626542ae4aa1d7e76 Mon Sep 17 00:00:00 2001 From: Jennifer Shehane Date: Thu, 26 Dec 2024 12:31:31 -0500 Subject: [PATCH 03/20] Fix link --- docs/accessibility/guides/introduction.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/accessibility/guides/introduction.mdx b/docs/accessibility/guides/introduction.mdx index 93c7eb7e4a..adc4f4131d 100644 --- a/docs/accessibility/guides/introduction.mdx +++ b/docs/accessibility/guides/introduction.mdx @@ -33,5 +33,5 @@ The end goal of this process is not to simply pass all your automated accessibil 1. [Block pull requests and set policies](/accessibility/guides/block-pull-requests) 1. [Feedback during local development](/accessibility/guides/local-development) 1. [Production monitoring](/accessibility/guides/production-monitoring) -1. [Maximize coverage](/accessibility/guides/maximizing-coverage) +1. [Maximize coverage](/accessibility/guides/maximize-coverage) 1. [Accessibility automation principles](/accessibility/guides/accessibility-automation) From 6829ef43deafa6a244aa608468389e7ca4cf982b Mon Sep 17 00:00:00 2001 From: Jennifer Shehane Date: Fri, 27 Dec 2024 10:27:20 -0500 Subject: [PATCH 04/20] Add how it works --- .../get-started/introduction.mdx | 39 ++++++------------- 1 file changed, 12 insertions(+), 27 deletions(-) diff --git a/docs/accessibility/get-started/introduction.mdx b/docs/accessibility/get-started/introduction.mdx index 4f09c70020..3341b1b334 100644 --- a/docs/accessibility/get-started/introduction.mdx +++ b/docs/accessibility/get-started/introduction.mdx @@ -49,7 +49,7 @@ From there, you can integrate with CI to set your own standards for handling the