search

dequelabs / axe-core

Accessibility engine for automated Web UI testing
https://www.deque.com/axe/
Mozilla Public License 2.0
5.95k stars 774 forks source link

Reorganise axe rule description page #998

Closed Wildebrew closed 4 years ago

Wildebrew commented 6 years ago

The aXe 3.0 list of rules support page needs better organization and context.

  1. There is no way to tell rules that produce violations from rules that are experimental/best practice or need manual verification. <html> elementn without a lang attrbute is always a violation whereas using bold elements to create headings is an experimental rule. The only way to tell the difference is to read the rule documentation.

  2. Related rules should be grouped together into logical categories rather than simply listed alphabetically.


axe-core version: X.Y.Z
axe-webdriver, extension or other integration version: X.Y.Z

Browser and Assistive Technology versions

For Tooling issues:
- Node version: XX  
- Platform:
WilcoFiers commented 6 years ago

Good idea Birkir. Maybe we can have something like the following table instead: https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md

We could see about updating this table to include links and to include if rules return incomplete, that'd be a worthwhile addition IMO.

marcysutton commented 6 years ago

I'm hearing that page wasn't intended to be used by the general public. @Wildebrew how did you happen to find that one–by modifying the URL to show the whole list?

Wildebrew commented 6 years ago

@Wilco, I like where you are going with this idea. I think the table needs a separate rule type column that states "violation" or "best practice". indicating best practice rules using tags is not sufficient in my opinion. The impact column is not a reliable indicator since best practice rules can have serious impact.

@marcy I got the link from one of my Deque contacts in response to an inquiry about Attest. My understanding was that the page was public. I don't see why it shouldn't be public, but that's not my call.

On 7/16/18, Marcy Sutton notifications@github.com wrote:

I'm hearing that page wasn't intended to be used by the general public. @Wildebrew how did you happen to find that one–by modifying the URL to show the whole list?

-- You are receiving this because you were mentioned. Reply to this email directly or view it on GitHub: https://github.com/dequelabs/axe-core/issues/998#issuecomment-405402964

-- Work hard. Have fun. Make history.

WilcoFiers commented 4 years ago

This was done a while ago. The rules table is now split up into a few categories: wcag2.0, wcag 2.1, best practice, experimental, deprecated.