Open Bug 1720275 Opened 3 years ago Updated 2 months ago

[meta] MDN documentation for WebDriver BiDi

Categories

(Remote Protocol :: WebDriver BiDi, task, P3)

task

Tracking

(Not tracked)

People

(Reporter: whimboo, Unassigned)

References

Details

(Keywords: meta)

For the WebDriver HTTP specification we have an existing but only partial documentation for client developers. This documentation can be found at: https://developer.mozilla.org/en-US/docs/Web/WebDriver.

There is also a MDN issue that discusses plans for further additions.

Nevertheless we should make sure to do better for WebDriver BiDi, and as such start early with landing the first pages for client developers. As best this would be a shared effort each stakeholder (browser vendor) could participate in.

A clear benefit is that all the content is no longer managed via a Wiki, but directly via Github at: https://github.com/mdn/content/tree/main/files/en-us/web/webdriver. As such writing documentation got way simpler.

Important to know for the web content to be added would be the kind of audience we are targeting here. IMO it will primarily be developers of various WebDriver client implementations. As such we should have a clean listing of available commands and events with their used payloads, and parameter types. Also the wording should be easier to understand as the specification itself. Automated documentation generation doesn't seem to be feasible at this point.

The entry point could be:
https://github.com/mdn/content/tree/main/files/en-us/web/webdriver_bidi

Further we probably want to feed in browser compatibility data to show the compatibility tables listing browser support (like that one for Array).

I'll bring-up this topic in tomorrow's monthly WebDriver meeting.

This topic was discussed in July. The meeting minutes can be found at:
https://www.w3.org/2021/07/14-webdriver-minutes.html#t02

Browser compatibility data can be found at: https://github.com/mdn/browser-compat-data/tree/main/webdriver/commands

We might be able to get it documented by tech writers via the open webdocs project. That idea has been added to:
https://github.com/openwebdocs/project/issues/42

Whiteboard: [bidi]

The meta keyword is there, the bug doesn't depend on other bugs and there is no activity for 12 months.
:whimboo, maybe it's time to close this bug?

Flags: needinfo?(hskupin)

Yes we should keep this bug open. Not sure still when we will have the time to get webdriver bidi specific pages added to MDN.

Flags: needinfo?(hskupin)

The meta keyword is there, the bug doesn't depend on other bugs and there is no activity for 12 months.
:whimboo, maybe it's time to close this bug?

Flags: needinfo?(hskupin)

No, we should keep it open. There is basically also an issue on the browser-compat-data repository which we might can get started first:
https://github.com/mdn/browser-compat-data/issues/20207

Flags: needinfo?(hskupin)

I've also filed a WebDriver BiDi spec issue to allow us to auto-generate the skeleton of the JSON files for browser compat data based on the CDDL definitions of the spec: https://github.com/w3c/webdriver-bidi/issues/619.

(In reply to Henrik Skupin [:whimboo][⌚️UTC+2] from comment #6)

I've also filed a WebDriver BiDi spec issue to allow us to auto-generate the skeleton of the JSON files for browser compat data based on the CDDL definitions of the spec: https://github.com/w3c/webdriver-bidi/issues/619.

Any kind of automation is done by the BCD collector. An appropriate issue is filed at https://github.com/openwebdocs/mdn-bcd-collector/issues/1762.

You need to log in before you can comment on or make changes to this bug.