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

Web APIs breadcrumb navigation should place interfaces below APIs #37241

Closed
scottdotweb opened this issue Dec 17, 2024 · 1 comment
Closed

Web APIs breadcrumb navigation should place interfaces below APIs #37241

scottdotweb opened this issue Dec 17, 2024 · 1 comment
Labels
closed: wontfix Out of scope, too much effort, or working as intended

Comments

@scottdotweb
Copy link
Contributor

MDN URL

https://developer.mozilla.org/en-US/docs/Web/API/Document

What specific section or headline is this issue about?

No response

What information was incorrect, unhelpful, or incomplete?

The Document interface is a subset of the DOM API. However, both of them appear at the same level within the breadcrumb navigation:

  • References > Web APIs > Document Object Model (DOM)
  • References > Web APIs > Document

There's a link to the DOM section at the top of the left hand side navigation, but as soon as you scroll that it's no longer visible. Navigating from an interface to its parent API is common and this impedes that.

What did you expect to see?

The breadcrumb navigation should present the full path to interfaces, accurately conveying their relationship to their parent API. In the case of Document that would be:

  • References > Web APIs > Document Object Model (DOM) > Document

This would allow the parent API to be reachable by a single click at all times.

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

No response

Do you have anything more you want to share?

No response

@scottdotweb scottdotweb added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Dec 17, 2024
@github-actions github-actions bot added Content:WebAPI Web API docs and removed Content:WebAPI Web API docs labels Dec 17, 2024
@Josh-Cena
Copy link
Member

Hi, this is the architecture we've chosen: interfaces are siblings of API overviews, not subpages. The reason being, not all interfaces clearly belong to one API: Navigator, Window, Element, etc. often have properties that are defined by other specs, making the architecture extremely confusing if each interface has to belong to one interface.

@Josh-Cena Josh-Cena closed this as not planned Won't fix, can't repro, duplicate, stale Dec 17, 2024
@Josh-Cena Josh-Cena added closed: wontfix Out of scope, too much effort, or working as intended and removed needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. labels Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
closed: wontfix Out of scope, too much effort, or working as intended
Projects
None yet
Development

No branches or pull requests

2 participants