|
| 1 | +# Accessibility |
| 2 | + |
| 3 | +AdLint includes a CLI, FastAPI service, reports, documentation, and a local Web |
| 4 | +UI. Accessibility work in this repo focuses on making policy review usable for |
| 5 | +keyboard-only users, screen reader users, low-vision users, and users who rely on |
| 6 | +structured output. |
| 7 | + |
| 8 | +## What we aim for |
| 9 | + |
| 10 | +- CLI output remains useful without color and supports JSON for automation. |
| 11 | +- Markdown reports use clear headings, tables, and descriptive links. |
| 12 | +- The local Web UI supports keyboard navigation and visible focus states. |
| 13 | +- Form fields have labels, descriptions, and useful error messages. |
| 14 | +- Review decisions do not depend on color alone. |
| 15 | +- Screenshots and docs include meaningful alt text. |
| 16 | +- Motion or loading states avoid creating barriers. |
| 17 | + |
| 18 | +## Reporting accessibility issues |
| 19 | + |
| 20 | +Please open an accessibility issue if you find: |
| 21 | + |
| 22 | +- unlabeled form controls or confusing focus order |
| 23 | +- color-only severity or decision indicators |
| 24 | +- reports that are hard to navigate with assistive technology |
| 25 | +- CLI output that cannot be understood without color |
| 26 | +- screenshots or docs without useful text alternatives |
| 27 | + |
| 28 | +Include the command, page, browser, terminal, operating system, assistive |
| 29 | +technology, and sample input when relevant. Do not include private ad copy, |
| 30 | +customer data, credentials, or raw real submissions. |
| 31 | + |
| 32 | +## Contribution expectations |
| 33 | + |
| 34 | +UI changes should include a keyboard pass, visible-focus check, and |
| 35 | +color-independent review of severity/status indicators. CLI/report changes |
| 36 | +should preserve structured output and readable text output. |
0 commit comments