Open Bug 1694136 Opened 7 months ago Updated 8 days ago

Refactor Remote Protocol documentation for various protocols (Marionette, WebDriver BiDi, and CDP) under /remote

Categories

(Remote Protocol :: Agent, task, P2)

task
Points:
2

Tracking

(Not tracked)

People

(Reporter: whimboo, Unassigned)

References

(Blocks 1 open bug, )

Details

(Whiteboard: [bidi-m2-mvp])

The documentation under /remote/docs needs to be updated. Now with CDP moved out maybe most of the content should also move to /remotet/cdp/, or at least gets its own section in the docs like /remote/docs/cdp/?

General documentation that relates to both CDP and BiDi has to remain top-level.

Points: --- → 2
Priority: -- → P2

Now that Marionette is also part of Remote Protocol we should include it here. One thing that we should discuss is the usefulness of the internal JS documentation for Marionette, and if it's really needed:

https://firefox-source-docs.mozilla.org/testing/marionette/internals/index.html

This came up on bug 1691414, and might require quite a bit of refactoring in the docs. Both Julian and I aren't seeing it that useful given that all the time we check the JSdoc comments in the source files instead.

Summary: Update documentation for CDP and BiDi separation → Update Remote Protocol documentation for various protocols (Marionette, WebDriver BiDi, and CDP) separation
Priority: P2 → P3
Whiteboard: [bidi-m1-mvp] → [bidi-m2-mvp]
Priority: P3 → --

We should make that a goal for milestone 2 now that all protocols are located under /remote.

Priority: -- → P2
Summary: Update Remote Protocol documentation for various protocols (Marionette, WebDriver BiDi, and CDP) separation → Refactor Remote Protocol documentation for various protocols (Marionette, WebDriver BiDi, and CDP) under /remote
You need to log in before you can comment on or make changes to this bug.