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

Update section on multiple h1 elements per page #18559

Merged
merged 3 commits into from
Sep 22, 2022
Merged

Update section on multiple h1 elements per page #18559

merged 3 commits into from
Sep 22, 2022

Conversation

robinmetral
Copy link
Contributor

@robinmetral robinmetral commented Jul 20, 2022

Summary

Update the section on the Heading Elements page to reflect the recent change to the HTML spec.

In a nutshell, to create a heading outline...

<main>
  <h1>Page title</h1>
  <section>
    <h1>Section title</h1> <!-- 🙅 don't do this -->
    <h2>Section title</h2> <!-- ✅ do this -->
  </section
</main>

Motivation

Make it clear that relying on the outline algorithm isn't only bad practice, it doesn't follow the spec.

Supporting details

Related issues

Related to #18530 (caused by the same change to the HTML spec)

Metadata

  • Adds a new document
  • Rewrites (or significantly expands) a document
  • Fixes a typo, bug, or other error
@robinmetral robinmetral requested a review from a team as a code owner July 20, 2022 15:55
@robinmetral robinmetral requested review from schalkneethling and removed request for a team July 20, 2022 15:55
@github-actions github-actions bot added the Content:HTML Hypertext Markup Language docs label Jul 20, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Jul 20, 2022

Preview URLs

Flaws

URL: /en-US/docs/Web/HTML/Element/Heading_Elements
Title: <h1>–<h6>: The HTML Section Heading elements
Flaw count: 1

  • macros:
    • wrong xref macro used (consider changing which macro you use)

External URLs

URL: /en-US/docs/Web/HTML/Element/Heading_Elements
Title: <h1>–<h6>: The HTML Section Heading elements

(this comment was updated 2022-09-22 05:36:16.996214)

Copy link
Contributor Author

@robinmetral robinmetral left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra details 👇

@sideshowbarker
Copy link
Collaborator

@stevefaulkner could you please give this one a review?

@schalkneethling schalkneethling removed their request for review August 31, 2022 22:02
@sideshowbarker sideshowbarker merged commit ffe4748 into mdn:main Sep 22, 2022
@robinmetral robinmetral deleted the update-multiple-h1s branch September 22, 2022 07:49
schalkneethling pushed a commit that referenced this pull request Sep 22, 2022
Co-authored-by: Scott O'Hara <scottaohara@users.noreply.github.com>
himanshugarg pushed a commit to himanshugarg/content that referenced this pull request Sep 27, 2022
Co-authored-by: Scott O'Hara <scottaohara@users.noreply.github.com>
@debiru
Copy link

debiru commented Oct 27, 2022

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
4 participants