-
Notifications
You must be signed in to change notification settings - Fork 22.8k
Move Events reference as one article under DOM API #40443
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
base: main
Are you sure you want to change the base?
Conversation
I think this is a great idea, so no objections from me. |
Anyone else we should consult? |
This is a good idea. I haven't reviewed the new events doc though, and won't unless requested. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Brian brought this to our internal team discussion and there was consensus to go ahead with this move. Thanks for this work! 🙌
I've left a few suggestions.
Do we need to capture the first para in https://developer.mozilla.org/en-US/docs/Web/Events/Event_handlers#what_are_the_available_events somewhere, maybe in a section before "See also" (I've suggested to add one) in the "DOM events" guide? Probably with a different heading that suggests where people can expect to find event documentation on MDN.
@@ -1,12 +1,15 @@ | |||
--- | |||
title: Event reference | |||
title: DOM events | |||
short-title: Events |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looking at other items in the sidebar (some of which are pretty long!):
short-title: Events | |
short-title: Understanding events |
or
short-title: Events | |
short-title: Working with events |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This guide talks about the list of events, working with events, and the conceptual model of events. It sounds a bit of a stretch to make the title any more specific than just "Events". I agree we should shorten the other title though.
--- | ||
|
||
{{DefaultAPISidebar("DOM")}} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would be nice to replace this macro as well with the sidebar
in fm at some point. Looks like only 9 files will be impacted
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like only 9 files will be impacted
Really? We do have a lot of DefaultAPISidebar
usage. Last time we agreed to only do this when we could move the sidebar parameter to a separate api-group
front matter.
@@ -530,4 +530,4 @@ A number of audio and video JavaScript libraries exist. The most popular librari | |||
- [Web Audio API](/en-US/docs/Web/API/Web_Audio_API) | |||
- [MediaStream Recording API](/en-US/docs/Web/API/MediaStream_Recording_API) | |||
- [getUserMedia](/en-US/docs/Web/API/MediaDevices/getUserMedia) | |||
- [Event reference: Media](/en-US/docs/Web/Events#media) | |||
- [Event reference: Media](/en-US/docs/Web/API/Document_Object_Model/Events#media) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should probably be moved to the Guides section.
Also change to "DOM events"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not too sure about that. The page is technically branded as a "guide", but this particular section feels much more "reference" than "guide". In the long term I'm not even sure if this hand-maintained table is sustainable, but for now I would just call it "Events index" and keep it as "reference".
- [Event reference: Media](/en-US/docs/Web/API/Document_Object_Model/Events#media) | |
- [Event index: Media](/en-US/docs/Web/API/Document_Object_Model/Events#media) |
Co-authored-by: Dipika Bhattacharya <[email protected]>
I know a lot of us have mixed feelings about the events reference, because it simply isn't supposed to be here. I'm merging everything into a single guide article, and next I will fix the broken anchors within in it (the current state gives me no appetite to modify this page).