Repository navigation
Provide rationale for the rules enabled or disabled #21
Description
I think it will be helpful to provide context on why we recommend these configurations.
In base.json
{
"default": true,
"no-inline-html": false,
"no-bare-urls": false,
"no-blanks-blockquote": false,
"fenced-code-language": true
}In accessibility.json
{
"no-alt-text": true,
"no-default-alt-text": true,
"no-duplicate-header": true,
"no-emphasis-as-header": true,
"no-generic-link-text": true,
"no-space-in-links": false,
"ol-prefix": "ordered",
"single-h1": true,
"ul-style": true
}Some of these are somewhat obvious, while others are less so.
Metadata
Metadata
Assignees
Labels
No labels
Activity
chris-c-thomas commentedon Feb 6, 2023
I think a doc page of some sort would definitely be great. I love opinionated things but also want to know the reasoning behind other's choices before I adopt it.
andrialexandrou commentedon Oct 9, 2023
Adding a note here to emphasize how some of the accessibility rules here are indeed related to accessibility, for instance