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

docs(hgroup): adds related note from a different page #30856

Merged
merged 4 commits into from
Dec 9, 2023

Conversation

kenji-webdev
Copy link
Contributor

Description

Adds note about <hgroup> previously only found on the Content categories page to <hgroup>'s page

Motivation

I believe it's important to include this note in <hgroup>'s page because as it stands right now it might mislead developers into using it, thinking that it has no drawbacks.

Someone might use <hgroup> instead of a <div> due to preference, so they can use it in a css selector or to create a reusable pre-styled container and unknowingly make their website less acessible.

I was reading through this page:
https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories

when I came across this note:

Note: The <hgroup> element is not recommended as it does not work properly with assistive technologies. It was removed from the W3C HTML specification prior to HTML 5 being finalized, but is still part of the WHATWG specification and is at least partially supported by most browsers.

I believe it's important to include this note in <hgroup>'s page because as it stands right now it might mislead developers into using it, thinking that it has no drawbacks.

Someone might use <hgroup> instead of a <div> due to preference, so they can use it in a css selector or to create a reusable pre-styled container and unknowingly make their website less acessible.
@kenji-webdev kenji-webdev requested a review from a team as a code owner December 7, 2023 18:27
@kenji-webdev kenji-webdev requested review from estelle and removed request for a team December 7, 2023 18:27
@github-actions github-actions bot added the Content:HTML Hypertext Markup Language docs label Dec 7, 2023
Copy link
Contributor

github-actions bot commented Dec 7, 2023

Preview URLs

(comment last updated: 2023-12-09 03:32:05)

Following `<optgroup>`'s example, I think it would be better for such an important note to be at the top
Copy link
Member

@estelle estelle left a comment

Choose a reason for hiding this comment

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

Thanks! 🎉

Copy link
Member

@estelle estelle left a comment

Choose a reason for hiding this comment

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

P.S. Congratulations on your first merged MDN content PR. Welcome to the team!

@estelle estelle merged commit fbb5b30 into mdn:main Dec 9, 2023
7 checks passed
@kenji-webdev
Copy link
Contributor Author

Thanks a lot. Glad to be here!

@kenji-webdev kenji-webdev deleted the patch-2 branch December 12, 2023 11:56
dipikabh pushed a commit to dipikabh/content that referenced this pull request Jan 17, 2024
* docs(hgroup): adds related note from a different page

I was reading through this page:
https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories

when I came across this note:

Note: The <hgroup> element is not recommended as it does not work properly with assistive technologies. It was removed from the W3C HTML specification prior to HTML 5 being finalized, but is still part of the WHATWG specification and is at least partially supported by most browsers.

I believe it's important to include this note in <hgroup>'s page because as it stands right now it might mislead developers into using it, thinking that it has no drawbacks.

Someone might use <hgroup> instead of a <div> due to preference, so they can use it in a css selector or to create a reusable pre-styled container and unknowingly make their website less acessible.

* refactor(hgroup): moves note to the top

Following `<optgroup>`'s example, I think it would be better for such an important note to be at the top

* refactor(hgroup): removes self-referencing anchor tag

* Update files/en-us/web/html/element/hgroup/index.md

---------

Co-authored-by: Estelle Weyl <[email protected]>
thibaudcolas added a commit to thibaudcolas/mdn-content that referenced this pull request Feb 11, 2024
thibaudcolas added a commit to thibaudcolas/mdn-content that referenced this pull request Feb 11, 2024
@thibaudcolas
Copy link
Contributor

thibaudcolas commented Feb 11, 2024

This isn’t looking right to me, as the disclaimers about <hgroup> were meant to be removed per #11153. I suspect that disclaimer on Content categories was outdated / shouldn’t have been there to start with, so I’ve reverted this change and removed the disclaimer in #32214.

estelle pushed a commit that referenced this pull request Feb 14, 2024
* Revert "docs(hgroup): adds related note from a different page (#30856)"

This reverts commit fbb5b30.

* Remove outdated hgroup disclaimer from Content Categories page
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants