Skip to content

Issues

Issues represent individual accessibility findings within a report. Each issue is a separate markdown file inside a report directory.

Issue Structure

An issue file contains frontmatter with metadata and a markdown body describing the finding.

Frontmatter Fields

yaml
---
title: Focus style missing on interactive elements
sc: 2.4.7
severity: high
difficulty: low
---
FieldDescription
titleShort description of the accessibility finding
scWCAG success criterion reference (e.g. 2.4.7)
severityImpact level: low, medium, high
difficultyEffort to fix: low, medium, high

Issue Body

The markdown body should include:

  • A description of the problem
  • Where the issue was found (affected pages or components)
  • How to reproduce the issue
  • A recommended fix

Example

markdown
---
title: Images missing alternative text
sc: 1.1.1
severity: high
difficulty: low
---

Several images on the homepage lack `alt` attributes. Screen reader
users will not know the purpose of these images.

## Affected pages

- Homepage (`/`)
- About page (`/about`)

## Recommendation

Add descriptive `alt` attributes to all informative images. Use
`alt=""` for purely decorative images.

Severity and Difficulty

These fields help prioritize remediation work:

  • Severity reflects the impact on users with disabilities
  • Difficulty reflects the estimated effort to implement a fix

Low-difficulty, high-severity issues should typically be addressed first.