spring-data-commons icon indicating copy to clipboard operation
spring-data-commons copied to clipboard

Documentation: level 5 and 6 (h6) section titles are visually indistinguishable

Open Chealer opened this issue 4 years ago • 1 comments

The Spring Data JPA Reference Documentation uses a rich structures with a large and deep section tree. Many sections reach levels 5 and 6, with titles using HTML h5 and h6 elements.

While there is a difference between these last levels in the table of contents (level 6 sections are not displayed), the content alone does not let readers see a difference between the two. On my Firefox 92, both are computed as having a bold black font with 19.2 pixels size.

An example can be seen in section 5.1.1, which has a level-6 section Custom Namespace Attributes inside the level-5 section Spring Namespace: image

One solution could be to make level-5 titles fully uppercase. Otherwise, numbering level 5 sections would workaround.

Chealer avatar Sep 10 '21 22:09 Chealer

Paging @Buzzardo and @oodamien

mp911de avatar Sep 14 '21 06:09 mp911de

Addressed via the migration to Antora.

mp911de avatar Apr 22 '24 12:04 mp911de