Skip to content

Commit 970ddd5

Browse files
committed
rework language about audits, links to specs
1 parent 8e122bb commit 970ddd5

File tree

1 file changed

+29
-4
lines changed

1 file changed

+29
-4
lines changed

docs/contributing.rst

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -321,11 +321,31 @@ Note that if needed, you can skip these checks with:
321321
git commit --no-verify
322322
323323
324-
Auditing accessibility
325-
======================
324+
Finding accessibility problems
325+
==============================
326+
327+
The accessibility checking tools can find a number of common HTML patterns which
328+
assistive technology can't help users understand.
329+
330+
In addition to `Lighthouse <https://developers.google.com/web/tools/lighthouse>`__
331+
in CI, the ``pa11y`` stack is installed as part of the development environment.
332+
333+
The key components are:
326334

327-
The accessibility checking tools are installed along with the rest of the `yarn`
328-
requirements. To run the accessibility auditing locally:
335+
- `pa11y <https://github.com/pa11y/pa11y>`__ which uses a headless browser to analyze
336+
an HTML page with a configurable set of rules based on publish standards
337+
- `Pa11y-CI <https://github.com/pa11y/pa11y-ci>`__ runs ``pa11y`` on multiple pages
338+
- `pa11y-reporter-html <https://github.com/pa11y/pa11y-reporter-html>`__ generates
339+
some nice HTML reports, suitable for review
340+
341+
.. Note::
342+
343+
Presently, the *default* ``pa11y`` ruleset, ``WCAG2AA`` is used, a subset of
344+
the `Web Content Accessibility Guidelines <https://www.w3.org/TR/WCAG21>`__.
345+
The `Quick Reference <https://www.w3.org/WAI/WCAG21/quickref>`__ may provide
346+
lighter reading.
347+
348+
To run the accessibility problem finder locally:
329349

330350
.. code-block:: bash
331351
@@ -343,6 +363,11 @@ The output of the last command includes:
343363
Fixing accessibility errors
344364
---------------------------
345365

366+
Start by checking for issues on the
367+
`accessibility roadmap <https://github.com/pandas-dev/pydata-sphinx-theme/blob/master/docs/a11y-roadmap.txt>`__.
368+
These are issues which are currently flagged by the toolset, but that have not yet
369+
been fixed. If that file is empty (or just comments), hooray!
370+
346371
To start working on one of the accessibility roadmap items, comment out one of the
347372
lines in `docs/a11y-roadmap.txt`, and re-run the audit to establish a baseline.
348373

0 commit comments

Comments
 (0)