Add Cypress Rules documentation #6215
Conversation
cypress-documentation
|
||||||||||||||||||||||||||||||||||||||||
| Project |
cypress-documentation
|
| Branch Review |
marktnoonan/app-quality-updates
|
| Run status |
|
| Run duration | 03m 48s |
| Commit |
|
| Committer | Mark Noonan |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
0
|
Pending
|
0
|
Skipped
|
0
|
Passing
|
309
|
| View all changes introduced in this branch ↗︎ | |
UI Coverage
10.99%
|
|
|---|---|
|
Untested elements
|
2445
|
|
Tested elements
|
3
|
Accessibility
96.99%
|
|
|---|---|
|
Failed rules
|
1 critical
3 serious
4 moderate
0 minor
|
|
Failed elements
|
25
|
…cypress-io/cypress-documentation into marktnoonan/app-quality-updates
Co-authored-by: Tyler Biethman <tbiethman@gmail.com>
Co-authored-by: Tyler Biethman <tbiethman@gmail.com>
| @@ -9,6 +9,20 @@ sidebar_position: 200 | |||
|
|
|||
| # Changelog | |||
|
|
|||
| ## Week of 6/2/2025 | |||
There was a problem hiding this comment.
@marktnoonan Did you mean to put the new rules in the changelog?
There was a problem hiding this comment.
adding now, ty!
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for the new Cypress custom accessibility rule and updates Results API docs to cover AWS CodeBuild and Drone CI support, along with minor cleanup and changelog entries.
- Introduce a new “Cypress Rules” docs page outlining the first custom rule
- Document AWS CodeBuild and Drone CI integration in both UI Coverage and Accessibility Results API
- Remove outdated frontmatter props, fix a typo, and add missing changelog entries
Reviewed Changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/ui-coverage/results-api.mdx | Added AWS CodeBuild & Drone CI tabs for UI Coverage Results API |
| docs/ui-coverage/get-started/introduction.mdx | Removed obsolete sidebar_custom_props |
| docs/ui-coverage/changelog.mdx | Added changelog entries for AWS CodeBuild and Drone CI support |
| docs/cloud/account-management/users.mdx | Fixed typo (“Cypres” → “Cypress”) |
| docs/accessibility/results-api.mdx | Added Basic example, baseline example, and Drone CI tab for Accessibility Results |
| docs/accessibility/guides/production-monitoring.mdx | Updated title/label, improved example comments |
| docs/accessibility/get-started/introduction.mdx | Removed obsolete sidebar_custom_props |
| docs/accessibility/core-concepts/cypress-rules.mdx | New documentation page for the custom Cypress accessibility rule |
| docs/accessibility/changelog.mdx | Added changelog entries for AWS CodeBuild and Drone CI support |
Comments suppressed due to low confidence (5)
docs/ui-coverage/results-api.mdx:24
- The
- Droneentry doesn’t include a hyperlink; consider linking to your Drone CI integration docs consistent with the other providers.
- Drone
docs/ui-coverage/results-api.mdx:382
- In the Drone YAML snippet, lines prefixed with
*are not valid YAML. Replace*with-to define thevalidatestep correctly.
* - name: validate
docs/accessibility/results-api.mdx:37
- The
- Dronebullet is missing a hyperlink; add a link to the Drone CI guide to match the format of the other CI providers.
- Drone
docs/accessibility/results-api.mdx:503
- The Drone YAML snippet uses
*prefixes for steps, which isn’t valid YAML. Use-to define each step.
* - name: validate
docs/accessibility/changelog.mdx:16
- [nitpick] Since you've added a new Cypress custom rule page, add a corresponding changelog entry (e.g., under the relevant week) to note the introduction of the
cy-semantic-html-warningrule.
## Week of 5/26/2025
docs/accessibility/results-api.mdx
Outdated
| #### `getAccessibilityResults` Arguments | ||
| #### How to use a previous run as a baseline | ||
|
|
||
| ```javascript title="scripts/verifyAccessibilityResults.js" |
There was a problem hiding this comment.
[nitpick] The baseline example duplicates the basic example above verbatim; consider consolidating or differentiating the two to reduce redundancy.
Copilot uses AI. Check for mistakes.
Co-authored-by: Tyler Biethman <tbiethman@gmail.com>
Co-authored-by: Tyler Biethman <tbiethman@gmail.com>
There was a problem hiding this comment.
@marktnoonan I might work on reframing this to focus on the 'why you need this' portion of the doc first. You're leading with the 'what Cypress did' and it took me a while to figure out why this is important to me as a user of the product exactly.
Not going to block here, but I had some typo fixes as well.
|
|
||
| # Cypress rules | ||
|
|
||
| In addition to running the default ruleset of the Axe-Core® library, Cypress develops custom rules that take advantage of the addition layer of information available in a test automation context. These rules are identified by a "Cypress Rule" badge, to distinguish them from the main Axe-Core® rule set. |
There was a problem hiding this comment.
| In addition to running the default ruleset of the Axe-Core® library, Cypress develops custom rules that take advantage of the addition layer of information available in a test automation context. These rules are identified by a "Cypress Rule" badge, to distinguish them from the main Axe-Core® rule set. | |
| In addition to running the default ruleset of the Axe-Core® library, Cypress offers custom rules that take advantage of the additional layer of information available in the test automation context. These rules are identified by a "Cypress Rule" badge, to distinguish them from the main Axe-Core® rule set. |
Co-authored-by: Jennifer Shehane <jennifer@cypress.io>
Co-authored-by: Tyler Biethman <tbiethman@gmail.com>
Co-authored-by: Jennifer Shehane <jennifer@cypress.io>
|
@jennifer-shehane this is a good point. Let me see what I can come up with on that framing. Maybe it should start with a section called "What are Cypress rues?" and "Why are custom rules needed?" |
…cypress-io/cypress-documentation into marktnoonan/app-quality-updates
|
@jennifer-shehane I've updated the intro. |
Co-authored-by: Tyler Biethman <tbiethman@gmail.com>
The first Cypress Accessibility custom rule will go live this week, this PR creates the docs for that.
This PR also makes a few other changes to catch up on some missing changelog entries and do some other light cleanup.