Skip to content

accessibility doc #1325

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

Merged
merged 1 commit into from
Feb 6, 2025
Merged

accessibility doc #1325

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 2 additions & 6 deletions docs/accessibility-automation-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,24 +76,20 @@ accessibility.wcagVersion: 'wcag21a'
```

### 3. Best Practices Checks
> The default value for **best practice** check is **`false`** focusing strictly on WCAG violations.

- **Purpose:** Include or exclude checks that go beyond the defined WCAG standards but are considered good practices for optimal usability.
- **Default Value:** The default setting is false, focusing strictly on WCAG violations.
- **Implementation:** Enable best practice checks by setting bestPractice to true in your configuration file.

> The default value for **best practice** check is **`false`**

```bash
accessibility.bestPractice: true
```

### 4. Needs Review

> The default value for **needs review** check is **`false`**
- **Purpose:** Flag potential accessibility issues that might require human evaluation for definitive assessment.
- **Implementation:** Enable needs review checks by setting needsReview to true in your configuration file. This ensures potentially ambiguous issues get flagged for manual review.

> The default value for **needs review** check is **`false`**

```bash
accessibility.needsReview: true
```
Loading