Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(cypress-accessibility-checker) update links in ReadMe #2188

Merged
merged 3 commits into from
Feb 10, 2025
Merged

fix(cypress-accessibility-checker) update links in ReadMe #2188

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6e0eebe
fix URL
philljenkins Feb 5, 2025
fadcc2d
fix all 404 links
philljenkins Feb 5, 2025
888cd39
Merge branch 'master' into phill-2135-readme
tombrunet Feb 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions cypress-accessibility-checker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ If you do not want to include `cypress-accessibility-checker` globally, you may

## Usage

The commands map directly to the description of the APIs located [in the accessibility-checker/src/README](https://github.com/IBMa/equal-access/blob/master/accessibility-checker/src/README.md). The names of the APIs within Cypress are just slightly different so they are globally unique in the Cypress namespace.
The commands map directly to the description of the APIs located in the [accessibility-checker/src/README](https://github.com/IBMa/equal-access/blob/master/accessibility-checker/src/README.md). The names of the APIs within Cypress are just slightly different so they are globally unique in the Cypress namespace.

The typical use case will be to get the accessibility compliance of a document and then assert the accessibility compliance against the configuration that is defined as part of the `.achecker.yml` file and any baselines that are defined. An example of how this looks is below:

Expand All @@ -75,7 +75,7 @@ The typical use case will be to get the accessibility compliance of a document a
cy.getCompliance('my scan').assertCompliance()
```

Examples of how to use each of the APIs below can be found in the `achecker.js` test file [located here](https://github.com/IBMa/equal-access/blob/master/cypress-accessibility-checker/test/cypress/integration/achecker.js).
Examples of how to use each of the APIs below can be found in the `achecker.js` test file [located here](https://github.com/IBMa/equal-access/blob/master/cypress-accessibility-checker/test/cypress/e2e/achecker.cy.js).

- `cy.getCompliance(label)`
- Similar to `getCompliance()` in the reference API above.
Expand All @@ -97,7 +97,7 @@ Chain the commands similar to other Cypress commands. For example, `cy.getCompli

Baselines are a helpful feature of `accessibility-checker` that can also be used in this Cypress wrapper. The concept involves capturing a scan result as a 'baseline' so that future scans will pass if they match the baseline. If they differ, then the test will fail. This feature is useful for things like false positives or issues you plan on not fixing.

The baseline feature is documented and implemented as part of `accessibility-checker`. Please see the [accessibility-checker/src/README](src/README.md) for details.
The baseline feature is documented and implemented as part of `accessibility-checker`. Please see the [accessibility-checker/src/README](https://github.com/IBMa/equal-access/blob/master/accessibility-checker/src/README.md) for details.

## Development

Expand Down