pa11y / pa11y-ci

Pa11y CI is a CI-centric accessibility test runner, built using Pa11y
https://pa11y.org
GNU Lesser General Public License v3.0
519 stars 63 forks source link

Improve documentation around options and defaults #140

Open josebolos opened 3 years ago

josebolos commented 3 years ago

The global options concurrency and useIncognitoBrowserContext are mentioned in passing in the Default configuration section of the README. For someone not familiar with pa11y this makes it look as if these options are part of the defaults that apply to each one of the tests, but they are instead global options exclusive to pa11y-ci.

We probably need to change the order of these options and add first a section with pa11y-ci's options, and then a second section or subsection dealing with specifying defaults for the tests.

Environment:

$ pa11y-ci -V
2.4.1