Skip to content

Commit b2e7ae2

Browse files
jennifer-shehanejennifer-shehane
authored
Add headings to pages with product names + icons (#6075)
* Add headings to pages with product names + icons * Add badges for all pages within our products * lint fix * Resolve duplicate headings that caused issues with links * Add Cypress App to App relevant pages + SEO improvements * lint * Fix duplicate heading
1 parent ca75c90 commit b2e7ae2

File tree

282 files changed

+1665
-235
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

282 files changed

+1665
-235
lines changed

‎docs/accessibility/changelog.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ sidebar_label: Changelog
55
sidebar_position: 200
66
---
77

8+
<ProductHeading product="accessibility" />
9+
810
# Changelog
911

1012
## Week of 11/11/2024

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ description: 'Configuration for Axe-Core® rules can be configured.'
44
sidebar_label: 'Axe Core® configuration'
55
---
66

7-
# Axe Core® configuration
7+
<ProductHeading product="accessibility" />
88

9-
<AccessibilityAddon />
9+
# Axe Core® configuration
1010

1111
Configuration for Axe-Core® rules is available through your Account Executive. 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.
1212

‎docs/accessibility/configuration/elementfilters.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ sidebar_label: elementFilters
55
sidebar_position: 20
66
---
77

8-
# elementFilters
8+
<ProductHeading product="accessibility" />
99

10-
<AccessibilityAddon />
10+
# elementFilters
1111

1212
:::info
1313

‎docs/accessibility/configuration/overview.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ description: 'Configuration allows you to customize and fine-tune Accessibility
55
sidebar_position: 10
66
---
77

8-
# Configuration
8+
<ProductHeading product="accessibility" />
99

10-
<AccessibilityAddon />
10+
# Configuration
1111

1212
Configuration allows you to customize and fine-tune Accessibility in Cypress. While Accessibility is designed to work seamlessly out of the box, there are instances where custom configuration may be necessary to address unique application structures, testing requirements, or edge cases. This section guides you through setting configuration to enhance the functionality and accuracy of Accessibility.
1313

‎docs/accessibility/configuration/viewfilters.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ sidebar_label: viewFilters
55
sidebar_position: 30
66
---
77

8-
# viewFilters
8+
<ProductHeading product="accessibility" />
99

10-
<AccessibilityAddon />
10+
# viewFilters
1111

1212
:::info
1313
Note: setting `viewFilters` impacts both Accessibility and UI Coverage reports.

‎docs/accessibility/configuration/views.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ sidebar_label: views
55
sidebar_position: 40
66
---
77

8-
# views
8+
<ProductHeading product="accessibility" />
99

10-
<AccessibilityAddon />
10+
# views
1111

1212
:::info
1313
Note: setting views impacts both Accessibility and UI Coverage reports.

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ sidebar_label: Accessibility score
55
sidebar_position: 30
66
---
77

8-
# Accessibility score
8+
<ProductHeading product="accessibility" />
99

10-
<AccessibilityAddon />
10+
# Accessibility score
1111

1212
Cypress provides a top-line percentage score to give a general sense of accessibility for your project. This score, calculated for a run, reflects the **average score** of **all application snapshots** captured during the run. It is based on the ratio of passing versus failing accessibility checks for each snapshot, with results weighted by the severity of the issues.
1313

‎docs/accessibility/core-concepts/how-it-works.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ sidebar_label: 'How it works'
55
sidebar_position: 40
66
---
77

8+
<ProductHeading product="accessibility" />
9+
810
# How it works
911

1012
Cypress Accessibility seamlessly integrates accessibility testing into your development pipeline. Below are the stages of the Cypress Accessibility process:

‎docs/accessibility/core-concepts/inspecting-violation-details.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ sidebar_label: Inspecting violation details
55
sidebar_position: 20
66
---
77

8-
# Inspecting violation details
8+
<ProductHeading product="accessibility" />
99

10-
<AccessibilityAddon />
10+
# Inspecting violation details
1111

1212
After navigating to a specific Rule of View from a [Run-level report](/accessibility/core-concepts/run-level-reports), you'll land on the Violation Detail view.
1313

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ sidebar_position: 10
55
sidebar_label: Run-level reports
66
---
77

8-
# Run-level reports
8+
<ProductHeading product="accessibility" />
99

10-
<AccessibilityAddon />
10+
# Run-level reports
1111

1212
This guide highlights the three main areas to focus on when reviewing an accessibility report for a Cypress run. It also explains key terms and definitions used in these reports.
1313

‎docs/accessibility/get-started/introduction.mdx

+3-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ sidebar_position: 10
66
sidebar_custom_props: { 'new_label': true }
77
---
88

9-
# Cypress Accessibility <Badge type="success">+ Add-on</Badge>
9+
<ProductHeading product="accessibility" />
10+
11+
# Automated accessibility checks on every test
1012

1113
Instantly visualize, triage, and fix accessibility violations without any additional code or configuration.
1214
Dive deep into each violation with live, fully-rendered DOM snapshots of your application as it appeared during your tests.

‎docs/accessibility/get-started/setup.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: 'Set up Cypress Accessibility by recording a run. No code changes o
55
sidebar_position: 20
66
---
77

8+
<ProductHeading product="accessibility" />
9+
810
# Get Started
911

1012
You don't need to make any changes to your code or your test setup. If you record test runs to the Cypress Cloud with Test Replay, you're ready to start using Cypress Accessibility.

‎docs/accessibility/guides/accessibility-automation.mdx

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22
sidebar_label: Accessibility automation principles
33
title: 'Accessibility automation principles | Cypress Accessibility Documentation'
44
description: "
5-
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."
5+
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."
66
sidebar_position: 80
77
---
88

9+
<ProductHeading product="accessibility" />
10+
911
# Accessibility automation principles
1012

1113
This guide outlines foundational concepts for using Cypress Accessibility, which also apply to accessibility automation tools in general.

‎docs/accessibility/guides/block-pull-requests.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: "Set policies and block pull requests automatically with Cypress Ac
55
sidebar_position: 40
66
---
77

8+
<ProductHeading product="accessibility" />
9+
810
# Block pull requests and set policies
911

1012
Cypress Accessibility reports are generated server-side in Cypress Cloud, based on test artifacts uploaded during execution. This ensures there is no performance impact on your Cypress test runs.

‎docs/accessibility/guides/improve-accessibility.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: 'Discover how to break down accessibility reports, prioritize fixes
55
sidebar_position: 20
66
---
77

8+
<ProductHeading product="accessibility" />
9+
810
# Improve accessibility
911

1012
This guide explains how to break down accessibility reports and create a focused plan for remediation using Cypress Accessibility.

‎docs/accessibility/guides/introduction.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
---
22
title: Introduction
3+
description: Learn how to set goals and make progress using Cypress Accessibility, generate reports during local development cycles, and monitor a production website.
34
sidebar_position: 10
45
---
56

7+
<ProductHeading product="accessibility" />
8+
9+
# Introduction
10+
611
:::info
712

813
##### <Icon name="question-circle" color="#4BBFD2" /> What you'll learn

‎docs/accessibility/guides/local-development.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: 'Get precise, fast, and scoped accessibility feedback during local
55
sidebar_position: 50
66
---
77

8+
<ProductHeading product="accessibility" />
9+
810
# Feedback during local development
911

1012
For reliable accessibility feedback during local development, the best approach is recording your tests directly to Cypress Cloud. By running tests related to your changes locally, you can bypass build pipelines and CI processes entirely. This can be achieved with a single command:

‎docs/accessibility/guides/maintain-accessibility.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: 'Learn how to maintain long-term accessibility with Cypress, using
55
sidebar_position: 30
66
---
77

8+
<ProductHeading product="accessibility" />
9+
810
# Maintain accessibility
911

1012
Accessibility isn't a one-time project—it's a continuous process. This guide explains how to transition from addressing known issues to maintaining long-term accessibility in your projects.

‎docs/accessibility/guides/maximize-coverage.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: "Expand accessibility testing by combining Cypress Accessibility's
55
sidebar_position: 70
66
---
77

8+
<ProductHeading product="accessibility" />
9+
810
# Maximize coverage
911

1012
As you become more familiar with accessibility violations and their underlying principles, you'll notice the connection between generic, automated checks (e.g., Axe Core®) and the specific user-facing behaviors of your application. Often, the insights gained from Cypress Accessibility's automated checks can guide you to create custom assertions tailored to your application's unique requirements.

‎docs/accessibility/guides/production-monitoring.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: 'Monitor accessibility issues in production by running scheduled Cy
55
sidebar_position: 60
66
---
77

8+
<ProductHeading product="accessibility" />
9+
810
# Production monitoring
911

1012
Cypress is commonly used in CI and local development workflows. It can also be leveraged to monitor production or staging environments through scheduled tests. This approach is particularly useful for environments involving dynamic content, such as those managed by Content Management Systems (CMS), where content changes can impact accessibility.

‎docs/accessibility/results-api.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ sidebar_label: Results API
55
sidebar_position: 100
66
---
77

8-
# Results API
8+
<ProductHeading product="accessibility" />
99

10-
<AccessibilityAddon />
10+
# Results API
1111

1212
The `@cypress/extract-cloud-results` module provides the `getAccessibilityResults` utility which enables you to programmatically fetch your run's Accessibility results in a CI environment. It determines the Cypress run created for the given CI workflow and will return the Accessibility results associated with that run. The results will be returned once the Cypress run has finished and the Accessibility report has been processed.
1313

‎docs/api/commands/and.mdx

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
---
2-
title: and
2+
title: 'and | Cypress Documentation'
3+
description: 'Create an assertion. Assertions are automatically retried as part of the previous command until they pass or time out.'
4+
sidebar_label: and
35
slug: /api/commands/and
46
---
57

8+
<ProductHeading product="app" />
9+
10+
# and
11+
612
Create an assertion. Assertions are automatically retried as part of the
713
previous command until they pass or time out.
814

‎docs/api/commands/as.mdx

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
---
2-
title: as
2+
title: 'as | Cypress Documentation'
3+
description: Assign an alias for later use in Cypress. Reference the alias later within a `cy.get()` query or `cy.wait()` command with an `@` prefix.
4+
sidebar_label: as
35
slug: /api/commands/as
46
---
57

8+
<ProductHeading product="app" />
9+
10+
# as
11+
612
Assign an alias for later use. Reference the alias later within a
713
[`cy.get()`](/api/commands/get) query or [`cy.wait()`](/api/commands/wait)
814
command with an `@` prefix.

‎docs/api/commands/blur.mdx

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
---
2-
title: blur
2+
title: 'blur | Cypress Documentation'
3+
description: Blur a focused element in Cypress.
4+
sidebar_label: blur
35
---
46

7+
<ProductHeading product="app" />
8+
9+
# blur
10+
511
Blur a focused element.
612

713
It is [unsafe](/app/core-concepts/retry-ability#Only-queries-are-retried) to

‎docs/api/commands/check.mdx

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
---
2-
title: check
2+
title: 'check | Cypress Documentation'
3+
description: Check checkbox(es) or radio(s) in Cypress.
4+
sidebar_label: check
35
slug: /api/commands/check
46
---
57

8+
<ProductHeading product="app" />
9+
10+
# check
11+
612
Check checkbox(es) or radio(s).
713

814
It is [unsafe](/app/core-concepts/retry-ability#Only-queries-are-retried) to

‎docs/api/commands/children.mdx

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
---
2-
title: children
2+
title: 'children | Cypress Documentation'
3+
description: Get the children of each DOM element within a set of DOM elements in Cypress.
4+
sidebar_label: children
35
slug: /api/commands/children
46
---
57

8+
<ProductHeading product="app" />
9+
10+
# children
11+
612
Get the children of each DOM element within a set of DOM elements.
713

814
:::info

‎docs/api/commands/clear.mdx

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
---
2-
title: clear
2+
title: 'clear | Cypress Documentation'
3+
description: Clear the value of an input or textarea in Cypress.
4+
sidebar_label: clear
35
slug: /api/commands/clear
46
---
57

8+
<ProductHeading product="app" />
9+
10+
# clear
11+
612
Clear the value of an `input` or `textarea`.
713

814
It is [unsafe](/app/core-concepts/retry-ability#Only-queries-are-retried) to

‎docs/api/commands/clearallcookies.mdx

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
---
2-
title: clearAllCookies
2+
title: 'clearAllCookies | Cypress Documentation'
3+
description: Clear all browser cookies in Cypress.
4+
sidebar_label: clearAllCookies
35
---
46

7+
<ProductHeading product="app" />
8+
9+
# clearAllCookies
10+
511
Clear all browser cookies.
612

713
:::caution

‎docs/api/commands/clearalllocalstorage.mdx

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
---
2-
title: clearAllLocalStorage
2+
title: 'clearAllLocalStorage | Cypress Documentation'
3+
description: Clear all localStorage data in Cypress.
4+
sidebar_label: clearAllLocalStorage
35
---
46

7+
<ProductHeading product="app" />
8+
9+
# clearAllLocalStorage
10+
511
Clear
612
[`localStorage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage)
713
data for all origins with which the test has interacted.

‎docs/api/commands/clearallsessionstorage.mdx

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
---
2-
title: clearAllSessionStorage
2+
title: 'clearAllSessionStorage | Cypress Documentation'
3+
description: Clear all session storage data in Cypress.
4+
sidebar_label: clearAllSessionStorage
35
---
46

7+
<ProductHeading product="app" />
8+
9+
# clearAllSessionStorage
10+
511
Clear
612
[`sessionStorage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage)
713
data for all origins with which the test has interacted.

‎docs/api/commands/clearcookie.mdx

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
---
2-
title: clearCookie
2+
title: 'clearCookie | Cypress Documentation'
3+
description: Clear a specific browser cookie in Cypress.
4+
sidebar_label: clearCookie
35
---
46

7+
<ProductHeading product="app" />
8+
9+
# clearCookie
10+
511
Clear a specific browser cookie.
612

713
:::caution

‎docs/api/commands/clearcookies.mdx

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
---
2-
title: clearCookies
2+
title: 'clearCookies | Cypress Documentation'
3+
description: Clear browser cookies for a domain in Cypress.
4+
sidebar_label: clearCookies
35
---
46

7+
<ProductHeading product="app" />
8+
9+
# clearCookies
10+
511
Clear browser cookies for a domain.
612

713
:::caution

0 commit comments

Comments
 (0)