fosrl / fosrl/docs-v2

Fix Mintlify accessibility issues: color contrast failure and missing image alt attributes

Open
#116 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
MDX
Stars
14
Forks
52
Avg merge
3h 13m
Merged PRs (30d)
2

Description

## Summary
(Fully generated by AI. Providing only the mint a11y output to AI)

Running `mint a11y` reports the following::

1. One color accessibility contrast issue in the Mintlify theme configuration
2. 26 missing `alt` attributes on image elements across 16 MDX files

These issues should be fixed so the documentation passes Mintlify accessibility checks and provides better support for screen readers and users relying on accessible documentation.

## Command

```bash
mint a11y
````

## Current result

```text
mint a11y

Checking color accessibility...
Primary Color (#202020) vs Light Background: PASS Excellent contrast ratio: 15.44:1 (meets WCAG AAA)
Light Color (#202020) vs Dark Background: FAIL Poor contrast ratio: 1.22:1 (fails WCAG AA, minimum required: 4.5:1)
Dark Color (#F36117) vs Dark Background: PASS Contrast ratio: 6.19:1 (meets minimum threshold of 3:1)
Dark Color (#F36117) vs Light Background: PASS Contrast ratio: 3.05:1 (meets minimum threshold of 3:1)
Overall Assessment: FAIL Some colors fail accessibility standards and should be updated
Checking mdx files for accessibility issues...
Found 26 accessibility issues in 16 files:
manage/access-control/approvals.mdx:
✗ Missing alt attribute on img element (line 21, col 3)
✗ Missing alt attribute on img element (line 27, col 3)
manage/access-control/create-user.mdx:
✗ Missing alt attribute on img element (line 21, col 3)
manage/access-control/links.mdx:
✗ Missing alt attribute on img element (line 48, col 3)
manage/access-control/login-page.mdx:
✗ Missing alt attribute on img element (line 32, col 3)
✗ Missing alt attribute on img element (line 46, col 3)
manage/analytics/access.mdx:
✗ Missing alt attribute on img element (line 29, col 3)
manage/analytics/action.mdx:
✗ Missing alt attribute on img element (line 29, col 3)
manage/analytics/request.mdx:
✗ Missing alt attribute on img element (line 26, col 3)
manage/analytics/streaming.mdx:
✗ Missing alt attribute on img element (line 29, col 3)
✗ Missing alt attribute on img element (line 37, col 3)
✗ Missing alt attribute on img element (line 46, col 3)
✗ Missing alt attribute on img element (line 50, col 3)
✗ Missing alt attribute on img element (line 56, col 3)
manage/blueprints.mdx:
✗ Missing alt attribute on img element (line 64, col 5)
manage/identity-providers/add-an-idp.mdx:
✗ Missing alt attribute on img element (line 25, col 3)
manage/identity-providers/auto-provisioning.mdx:
✗ Missing alt attribute on img element (line 19, col 3)
✗ Missing alt attribute on img element (line 27, col 3)
✗ Missing alt attribute on img element (line 43, col 3)
✗ Missing alt attribute on img element (line 53, col 3)
✗ Missing alt attribute on img element (line 66, col 3)
manage/identity-providers/azure.mdx:
✗ Missing alt attribute on img element (line 45, col 3)
manage/identity-providers/google.mdx:
✗ Missing alt attribute on img element (line 54, col 3)
manage/identity-providers/openid-connect.mdx:
✗ Missing alt attribute on img element (line 19, col 3)
manage/remote-node/understanding-nodes.mdx:
✗ Missing alt attribute on img element (line 32, col 3)
self-host/advanced/cloudflare-proxy.mdx:
✗ Missing alt attribute on img element (line 146, col 3)
Recommendation: Add alt attributes to all images and videos for better accessibility.
```

---

## Color accessibility issue

The current light color value has insufficient contrast against the dark background:

```text
Light Color (#202020) vs Dark Background: FAIL
Contrast ratio: 1.22:1
Required minimum: 4.5:1
```

## Missing image alt attributes

`mint a11y` reports 26 missing `alt` attributes in 16 files.

Each affected image should receive a meaningful `alt` attribute that describes the purpose of the image in context. Decorative images, if any, should explicitly use an empty alt attribute only when appropriate.

## Affected files

### `manage/access-control/approvals.mdx`

```text
✗ Missing alt attribute on img element (line 21, col 3)
✗ Missing alt attribute on img element (line 27, col 3)
```

### `manage/access-control/create-user.mdx`

```text
✗ Missing alt attribute on img element (line 21, col 3)
```

### `manage/access-control/links.mdx`

```text
✗ Missing alt attribute on img element (line 48, col 3)
```

### `manage/access-control/login-page.mdx`

```text
✗ Missing alt attribute on img element (line 32, col 3)
✗ Missing alt attribute on img element (line 46, col 3)
```

### `manage/analytics/access.mdx`

```text
✗ Missing alt attribute on img element (line 29, col 3)
```

### `manage/analytics/action.mdx`

```text
✗ Missing alt attribute on img element (line 29, col 3)
```

### `manage/analytics/request.mdx`

```text
✗ Missing alt attribute on img element (line 26, col 3)
```

### `manage/analytics/streaming.mdx`

```text
✗ Missing alt attribute on img element (line 29, col 3)
✗ Missing alt attribute on img element (line 37, col 3)
✗ Missing alt attribute on img element (line 46, col 3)
✗ Missing alt attribute on img element (line 50, col 3)
✗ Missing alt attribute on img element (line 56, col 3)
```

### `manage/blueprints.mdx`

```text
✗ Missing alt attribute on img element (line 64, col 5)
```

### `manage/identity-providers/add-an-idp.mdx`

```text
✗ Missing alt attribute on img element (line 25, col 3)
```

### `manage/identity-providers/auto-provisioning.mdx`

```text
✗ Missing alt attribute on img element (line 19, col 3)
✗ Missing alt attribute on img element (line 27, col 3)
✗ Missing alt attribute on img element (line 43, col 3)
✗ Missing alt attribute on img element (line 53, col 3)
✗ Missing alt attribute on img element (line 66, col 3)
```

### `manage/identity-providers/azure.mdx`

```text
✗ Missing alt attribute on img element (line 45, col 3)
```

### `manage/identity-providers/google.mdx`

```text
✗ Missing alt attribute on img element (line 54, col 3)
```

### `manage/identity-providers/openid-connect.mdx`

```text
✗ Missing alt attribute on img element (line 19, col 3)
```

### `manage/remote-node/understanding-nodes.mdx`

```text
✗ Missing alt attribute on img element (line 32, col 3)
```

### `self-host/advanced/cloudflare-proxy.mdx`

```text
✗ Missing alt attribute on img element (line 146, col 3)
```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.