Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inconsistent headings for HTML content categories article #29677

Open
rami-daoud opened this issue Oct 17, 2023 · 2 comments
Open

Inconsistent headings for HTML content categories article #29677

rami-daoud opened this issue Oct 17, 2023 · 2 comments
Labels
Content:HTML Hypertext Markup Language docs effort: medium This task is a medium effort. goal: consistency (Experimental label) Issues about inconsistent/conflicting/contradictory content.

Comments

@rami-daoud
Copy link

rami-daoud commented Oct 17, 2023

MDN URL

https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories

What specific section or headline is this issue about?

Headings are not consistent

What information was incorrect, unhelpful, or incomplete?

The writer shows these categories in the beginning of the article:

  • Main content categories,
  • Form-related content categories,
  • Specific content categories

so I expect to see them in H2 as I read forward. but what actually in H2 are

  • Main content categories
  • Secondary categories
  • Transparent content model

What did you expect to see?

  • Main content categories
    • Metadata content
    • Flow content
    • Sectioning content
    • Heading content
    • Phrasing content
    • Embedded content
    • Interactive content
  • Form-related content categories
    • Form-associated content
    • Labelable elements
    • Submittable elements
    • Resettable elements
  • Specific content categories
    • Script-supporting elements
    • Palpable content
    • Transparent content model

Do you have any supporting links, references, or citations?

Do you have anything more you want to share?

MDN metadata

@rami-daoud rami-daoud added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Oct 17, 2023
@github-actions github-actions bot added the Content:HTML Hypertext Markup Language docs label Oct 17, 2023
@caugner caugner added goal: consistency (Experimental label) Issues about inconsistent/conflicting/contradictory content. and removed needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. labels Nov 2, 2023
@caugner
Copy link
Contributor

caugner commented Nov 2, 2023

I can confirm the issue. The introduction says:

There are three types of content categories:

  • Main content categories, which describe common rules shared by many elements.
  • Form-related content categories, which describe rules common to form-related elements.
  • Specific content categories, which describe rare categories shared only by a few elements, sometimes only in a specific context.

But two of the three <h2> have deviating titles.

@caugner caugner added the effort: small This task is a small effort. label Nov 2, 2023
@caugner
Copy link
Contributor

caugner commented Nov 2, 2023

Note that this issue is not trivial to resolve.

Maybe it would make sense to promote some <h3>s to <h2> and remove this initial listing of "three types of content categories", as well as the "Main content categories" h2, because it seems to be a vague meta category.

@caugner caugner added effort: medium This task is a medium effort. and removed effort: small This task is a small effort. labels Nov 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:HTML Hypertext Markup Language docs effort: medium This task is a medium effort. goal: consistency (Experimental label) Issues about inconsistent/conflicting/contradictory content.
2 participants