#37409: Ambiguous "Overview" link text on the documentation home page
-------------------------------------+-------------------------------------
Reporter: Natalia | Owner: Natalia Bidart
Bidart |
Type: | Status: assigned
Cleanup/optimization |
Component: | Version: 6.1
Documentation |
Severity: Normal | Keywords: accessibility
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------+-------------------------------------
The [
https://docs.djangoproject.com/en/6.1/ documentation home page] uses
`Overview` as the link text 15 times. It is the only duplicated link text
on the page. A sighted reader sees which group each one belongs to;
someone navigating by a list of links gets 15 identical entries. Most of
this is self-inflicted. Every one of those targets already has a distinct
title, which `docs/index.txt` overrides with the generic word.
For most of them the fix is to remove the explicit title and let `:doc:`
use the document's own. Where that would repeat the group label, a short
descriptive title does the job. While fixing the link text, a few groups
are worth tidying: single-link groups whose label repeats their only link,
and `About this documentation`, which is already reachable under
Contributing to Django.
This is a derived from this [
https://forum.djangoproject.com/t/a-more-
accessible-home-page-table-of-contents/46072/ forum post], following
ticket #37051.
--
Ticket URL: <
https://code.djangoproject.com/ticket/37409>
Django <
https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.