Semantic and accessibility problems
I was testing the built in manual in tor browser in tpo/applications/tor-browser#41421 and a few of the listed issues apply to the web manual as well, which tor browser inherits. I'll copy and adapt the relevant ones:
- The list of links on the main page uses
<h5></h5><p></p>
structure. Besides the incorrect heading level, this should probably just be a<nav>
anyway. - On the main page, there is an empty
<h5><a href="menu"></a></h5>
at the top of the page, which causes screen reader noise. It should be removed or hidden. - On sub-pages, the side navigation bar "Topics" heading is
<h4>
rather than<h2>
. - On sub-pages, at the top of the main content there is an empty
<h3><a href="running-tor-browser" role="button"></a></h3>
. It should be removed. - On sub-pages, at the top of the main content is a
<h5>
element which contains a link to the same page, this should just be a plain<a>
element with no wrapping heading element. - The sub-pages, the main content starts with
<h3>
headings, rather than<h2>
. - The alt text for
<img>
elements are not very descriptive of the image. A lot of these are screenshots, but don't describe themselves as screenshots. - Some of the text is geared towards users who can see the screenshots.
An example for point 6 would be in the "about:manual#running-tor-browser" page. We have
CONFIGURE
Tor Browser will take you through a series of configuration options.
The Connection Assist informs you about the state of your Internet connection and your connection to the Tor network.
[image]
[image]
The first checkbox is 'Quickstart'. If selected, every time you open Tor Browser, it will try to connect with your previous network settings.
There's no indication that this "configure" is in the settings page, or that "Connection" and "Quickstart" are sections of this page. Using good alt text would help a little, but making the text clearer would help clarify things for all users. Generally, you want something that you could directly read over the phone to help someone on the other end.
Moreover, the use of "Connection Assist" is confusing because the section just before is called "CONNECTION ASSIST", which is something else.