Skip to content

Wrong heading levels in generated HTML? #1822

Description

@BurdetteLamar

Aliki format for class/module has H1 element for title, and H3 elements for boiler-plate sections "Constants,", "Public Class Methods," etc.

This means that when the last heading in the (human-written) class/module doc is H2 (say, titled "Foo"), the right-side "On This Page" section will make it appear the boiler-plate elements are subordinate to the "Foo" section.

See, for example, https://docs.ruby-lang.org/en/master/Integer.html, wherein the H2 section "What's Here" seems to contain sections "Constants" etc.

I think the boiler-plate sections should be H2, and thereby subordinate only to the H1 title.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions