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

Switch to <ol> for breadcrumb #37273

Merged
merged 2 commits into from
Dec 20, 2024
Merged

Switch to <ol> for breadcrumb #37273

merged 2 commits into from
Dec 20, 2024

Conversation

lescx
Copy link
Contributor

@lescx lescx commented Dec 19, 2024

The Breadcrumb Glossary page notes

Note: While there's no dedicated semantic HTML element for breadcrumb navigation menus, the <ol> element is commonly used to represent their hierarchical structure.

Description

I suggest following our own advice. From a semantically standpoint, it just makes to use an ordered list. This tiny PR replaces the <ul> to a <ol>.

Motivation

From a semantic point of view, it makes sense to switch to an ordered list.

The Breadcrumb Glossary page notes

> _Note: While there's no dedicated semantic HTML element for breadcrumb navigation menus, the <ol> element is commonly used to represent their hierarchical structure._

I suggest following our own advice. From a semantically standpoint, it just makes to use an ordered list.
@lescx lescx requested a review from a team as a code owner December 19, 2024 09:29
@lescx lescx requested review from estelle and removed request for a team December 19, 2024 09:29
@github-actions github-actions bot added Content:CSS Cascading Style Sheets docs size/xs [PR only] 0-5 LoC changed labels Dec 19, 2024
@hamishwillee
Copy link
Collaborator

Can you make the corresponding CSS changes so that this modification works?

Copy link
Contributor

github-actions bot commented Dec 19, 2024

Preview URLs

Flaws (48)

URL: /en-US/docs/Web/CSS/Layout_cookbook/Breadcrumb_Navigation
Title: Breadcrumb navigation
Flaw count: 48

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/CSS
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web/CSS_basics
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/CSS/First_steps
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/CSS/First_steps/What_is_CSS
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/CSS/First_steps/Getting_started
    • and 43 more flaws omitted

(comment last updated: 2024-12-20 17:11:48)

Requested changes from #37273 to update corresponding CSS.
@github-actions github-actions bot added size/s [PR only] 6-50 LoC changed and removed size/xs [PR only] 0-5 LoC changed labels Dec 20, 2024
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.

Thank you.
Congratulations on your first merged MDN content PR.
Welcome to the team!

@estelle estelle merged commit 0dd1289 into mdn:main Dec 20, 2024
8 checks passed
allan-bonadio pushed a commit to allan-bonadio/content that referenced this pull request Dec 25, 2024
* Switch to `<ol>` for breadcrumb

The Breadcrumb Glossary page notes

> _Note: While there's no dedicated semantic HTML element for breadcrumb navigation menus, the <ol> element is commonly used to represent their hierarchical structure._

I suggest following our own advice. From a semantically standpoint, it just makes to use an ordered list.

* Update corresponding CSS

Requested changes from mdn#37273 to update corresponding CSS.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:CSS Cascading Style Sheets docs size/s [PR only] 6-50 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants