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

UIEvent and UI_Events pages have no cross-links #37803

Closed
allan-bonadio opened this issue Jan 25, 2025 · 3 comments · Fixed by #38062
Closed

UIEvent and UI_Events pages have no cross-links #37803

allan-bonadio opened this issue Jan 25, 2025 · 3 comments · Fixed by #38062
Labels
Content:WebAPI Web API docs good first issue A good issue for newcomers to get started with.

Comments

@allan-bonadio
Copy link
Contributor

MDN URL

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

What specific section or headline is this issue about?

Intro, See Also

What information was incorrect, unhelpful, or incomplete?

There's two articles, UIEvent and UI_Events:

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

This is pretty confusing. For a long while, I'd go to one of these pages and try to find info that I saw on the other, which wasn't there. But, the worst part is, there's few links between UI_Events and UIEvent; in fact, just one.

The first one discusses the UIEvent class itself. But it doesn't discuss any subclasses of UIEvent. There's no way to go to UI_Events from there.

The second one has a list of the individual UI events. And, one link to UIEvent, buried in the middle of a table. But, given the confusing nature of this situation, there should be more.

To add to the confusion, there's also a page for the constructor for UIEvent. It does have a link to UIEvent.
https://developer.mozilla.org/en-US/docs/Web/API/UIEvent/UIEvent

What did you expect to see?

Some explanation that there's two different pages, how they differ, and links to each other. At least in the See Also section, but probably also in the text.

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

the pages themselves:

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

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

Do you have anything more you want to share?

I'll try to make a PR for the changes needed.

@allan-bonadio allan-bonadio added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Jan 25, 2025
@github-actions github-actions bot added the Content:WebAPI Web API docs label Jan 25, 2025
@Josh-Cena
Copy link
Member

"UI_Events" is an API overview page, like "WebRTC API" or "Fetch API". "UIEvent" is the documentation for the interface UIEvent, which is a part of the "UI Events" API (the latter consists of many other features as you can see on its overview page). We should definitely link to "UI Events" from the UIEvent interface page, but I'm not sure if there's more to be done about it. I assume you wouldn't be confused by the simultaneous existence of "Fetch API" and fetch(), or "Console API" and console.

@Josh-Cena Josh-Cena removed the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Jan 26, 2025
@Josh-Cena Josh-Cena added the good first issue A good issue for newcomers to get started with. label Feb 8, 2025
@Josh-Cena
Copy link
Member

Welcoming a link either in the intro paragraph or in the "See also" section, or both, on the UIEvent page, to the "UI_Events" page.

@mohanad-80
Copy link
Contributor

Hi!
I'd like to work on this and submit a PR. if no one else is already working on it, I'll go ahead. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs good first issue A good issue for newcomers to get started with.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants