[Editorial review] BiDi - Add pages for browsingContext module, part 2: context lifecycle command and events#44279
Conversation
|
Preview URLs (5 pages)
Flaws (1) Note! 4 documents with no flaws that don't need to be listed. 🎉 Found an unexpected or unresolvable flaw? Please report it here. URL:
(comment last updated: 2026-06-03 20:40:21) |
chrisdavidmills
left a comment
There was a problem hiding this comment.
Hi @dipikabh! I have a few comments for you to consider, but overall, this is looking pretty decent. Nice work.
|
|
||
| ## Commands | ||
|
|
||
| - [`browsingContext.getTree`](/en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/getTree) |
There was a problem hiding this comment.
Shouldn't these list items be DLs, with descriptions of each item?
There was a problem hiding this comment.
So, because I want to list commands and events in their respective sections on the landing page, I can't use
the SubPagesWithSummaries macro - as far as I know, it generates one flat list of all the child pages in the parent directory. And so the links here are not auto-generated, I'm adding them to the list as I author the pages.
I'm less inclined to add descriptions manually since they'd risk getting out of sync with the descriptions on the actual pages. But I'm happy to reconsider if you feel strongly that this would be significantly useful to readers - what do you think?
There was a problem hiding this comment.
It would be useful, and also more consistent with how we do things normally on MDN landing pages.
But if you are hitting some kind of technical limitation (I didn't exactly understand the bit about the macro), then I think we can live with it.
There was a problem hiding this comment.
Got it, let me consider the options and address in a follow-up.
About the macro, I meant when i use SubPagesWithSummaries, it generates something like this:
that is, a flat list of all child pages with no provision to separate them into Commands and Events sections. The macro cannot target the pages by page-type for me to split them into sections.
lutien
left a comment
There was a problem hiding this comment.
Thanks! That looks good to me!
| The `params` field in the event notification is a context object with the following properties, describing the discarded context and its subtree: | ||
|
|
||
| - `children` | ||
| - : An array of context objects that represents child contexts. |
There was a problem hiding this comment.
Do we have a definition of the context info type that we could link here? Maybe we could use the one from browsingContext.getTree?
There was a problem hiding this comment.
We're not covering types separately.
But that's a nice hint - I've linked "context object" to the return value in browsingContext.getTree. Also added the link in browsingContext.contextCreated.
|
This pull request has merge conflicts that must be resolved before it can be merged. |
e213ec1 to
b792d57
Compare
chrisdavidmills
left a comment
There was a problem hiding this comment.
@dipikabh, lovely work: I'm pretty happy with this now. I've added a few follow-up comments; I think only one of them requires some thought. I'll approve it anyway, so you can merge when done.
Description
This PR adds the second set of pages related to the context life cycle:
browsingContext.getTreebrowsingContext.contextCreatedbrowsingContext.contextDestroyedOther pages updated include:
browsingContextmodule landing page: Added list items for the three new pages(the base content updates to this file are in the part 1 set)
input.fileDialogOpened: Added "active session" to the example intro for consistencySpec links
Related issue
Doc issue: mdn/mdn#339