[Django] #34911: Admindocs index skips from h1 to h3

1 view
Skip to first unread message

Django

unread,
Oct 19, 2023, 3:04:50 PM10/19/23
to django-...@googlegroups.com
#34911: Admindocs index skips from h1 to h3
-------------------------------------+-------------------------------------
Reporter: Thibaud | Owner: laserhyena
Colas |
Type: Bug | Status: assigned
Component: | Version: dev
contrib.admindocs | Keywords: accessibility,
Severity: Normal | screen reader, headings
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 1 |
-------------------------------------+-------------------------------------
On /admin/doc, the index page has a `<h1>Documentation</h1>`, and then
skips straight to headings level 3. We should instead have headings level
2 so as to avoid confusing screen reader users navigating by heading.

See for example: [https://static-django-
demo.netlify.app/django_admin_tests/v5.0/english/admin/docs/ /admin/docs/
on static-django-demo].

--
Ticket URL: <https://code.djangoproject.com/ticket/34911>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Oct 19, 2023, 3:07:40 PM10/19/23
to django-...@googlegroups.com
#34911: Admindocs index skips from h1 to h3
-------------------------------------+-------------------------------------
Reporter: Thibaud Colas | Owner:
| laserhyena
Type: Bug | Status: assigned
Component: contrib.admindocs | Version: dev
Severity: Normal | Resolution:
Keywords: accessibility, | Triage Stage: Accepted
screen reader, headings |
Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------------+-------------------------------------
Changes (by Mariusz Felisiak):

* stage: Unreviewed => Accepted


--
Ticket URL: <https://code.djangoproject.com/ticket/34911#comment:1>

Django

unread,
Oct 19, 2023, 4:20:50 PM10/19/23
to django-...@googlegroups.com
#34911: Admindocs index skips from h1 to h3
-------------------------------------+-------------------------------------
Reporter: Thibaud Colas | Owner:
| laserhyena
Type: Bug | Status: assigned
Component: contrib.admindocs | Version: dev
Severity: Normal | Resolution:
Keywords: accessibility, | Triage Stage: Accepted
screen reader, headings |
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------------+-------------------------------------

Comment (by laserhyena):

[https://github.com/django/django/pull/17385 PR]

--
Ticket URL: <https://code.djangoproject.com/ticket/34911#comment:2>

Django

unread,
Oct 19, 2023, 11:49:49 PM10/19/23
to django-...@googlegroups.com
#34911: Admindocs index skips from h1 to h3
-------------------------------------+-------------------------------------
Reporter: Thibaud Colas | Owner:
| laserhyena
Type: Bug | Status: assigned
Component: contrib.admindocs | Version: dev
Severity: Normal | Resolution:
Keywords: accessibility, | Triage Stage: Ready for
screen reader, headings | checkin
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------------+-------------------------------------
Changes (by Mariusz Felisiak):

* has_patch: 0 => 1
* stage: Accepted => Ready for checkin


--
Ticket URL: <https://code.djangoproject.com/ticket/34911#comment:3>

Django

unread,
Oct 20, 2023, 12:20:34 AM10/20/23
to django-...@googlegroups.com
#34911: Admindocs index skips from h1 to h3
-------------------------------------+-------------------------------------
Reporter: Thibaud Colas | Owner:
| laserhyena
Type: Bug | Status: closed
Component: contrib.admindocs | Version: dev
Severity: Normal | Resolution: fixed

Keywords: accessibility, | Triage Stage: Ready for
screen reader, headings | checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------------+-------------------------------------
Changes (by Mariusz Felisiak <felisiak.mariusz@…>):

* status: assigned => closed
* resolution: => fixed


Comment:

In [changeset:"21382e2743d06efbf5623e7c9b6dccf2a325669b" 21382e27]:
{{{
#!CommitTicketReference repository=""
revision="21382e2743d06efbf5623e7c9b6dccf2a325669b"
Fixed #34911 -- Corrected HTML heading levels on admindocs' main page.
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/34911#comment:4>

Django

unread,
Oct 20, 2023, 12:20:57 AM10/20/23
to django-...@googlegroups.com
#34911: Admindocs index skips from h1 to h3
-------------------------------------+-------------------------------------
Reporter: Thibaud Colas | Owner:
| laserhyena
Type: Bug | Status: closed
Component: contrib.admindocs | Version: dev
Severity: Normal | Resolution: fixed
Keywords: accessibility, | Triage Stage: Ready for
screen reader, headings | checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------------+-------------------------------------

Comment (by Mariusz Felisiak <felisiak.mariusz@…>):

In [changeset:"bba963df50f73f14f7e48f285f9bc920e48093cb" bba963d]:
{{{
#!CommitTicketReference repository=""
revision="bba963df50f73f14f7e48f285f9bc920e48093cb"
[5.0.x] Fixed #34911 -- Corrected HTML heading levels on admindocs' main
page.

Backport of 21382e2743d06efbf5623e7c9b6dccf2a325669b from main
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/34911#comment:5>

Reply all
Reply to author
Forward
0 new messages