Bug 1694136 - [remote] Move all documentation files for remote protocols under remote/doc r=webdriver-reviewers,whimboo

Depends on D132047

This patch only changes the folder organisation for remote protocol docs.
They should still be displayed in the exact same way on https://firefox-source-docs.mozilla.org

Differential Revision: https://phabricator.services.mozilla.com/D132049

Author: juliandescottes

remote/doc/Debugging.md

@@ -23,7 +23,7 @@ To dump events produced by EventEmitter,
 including CDP events produced by the Remote Agent,
 you can use the `toolkit.dump.emit` [preference]:
 
-  ./mach run --setpref "toolkit.dump.emit=true" --remote-debuggiing-port
+  ./mach run --setpref "toolkit.dump.emit=true" --remote-debugging-port
 
 
 Logging observer notifications

remote/doc/Architecture.md remote/doc/cdp/Architecture.md

@@ -74,7 +74,7 @@ process interspersed with some tips.
    up for review, run the Puppeteer test job on try again with `--rebuild 10`
 	 to check for stability.
 
-[Testing]: ./Testing.html
+[Testing]: ../Testing.html
 [Puppeteer test suite]: https://github.com/GoogleChrome/puppeteer/tree/master/test
 [re-install the project]: https://github.com/puppeteer/puppeteer/blob/main/CONTRIBUTING.md#getting-code
 [run tests against both Chromium and Firefox]: https://github.com/puppeteer/puppeteer/blob/main/test/README.md#running-tests

remote/doc/PuppeteerVendor.md remote/doc/cdp/PuppeteerVendor.md

@@ -0,0 +1,23 @@
+=====================
+Remote Protocol (CDP)
+=====================
+
+The Firefox **remote protocol (CDP)** is a low-level debugging interface
+you can use to inspect the state and control execution of documents
+running in web content, instrument the browser in interesting ways,
+simulate user interaction for automation purposes, and for subscribing
+to updates in the browser such as network- or console logs.
+
+It complements the existing Firefox Developer Tools :ref:`Remote Debugging
+Protocol <Remote Debugging Protocol>` (RDP) by implementing a subset of the
+`Chrome DevTools Protocol`_ (CDP).
+
+.. _Chrome DevTools Protocol: https://chromedevtools.github.io/devtools-protocol/
+
+.. toctree::
+  :maxdepth: 1
+
+  Usage.md
+  Architecture.md
+  PuppeteerVendor.md
+

remote/doc/Usage.md remote/doc/cdp/Usage.md

@@ -1,42 +1,69 @@
-===============
-Remote Protocol
-===============
+================
+Remote Protocols
+================
 
-The Firefox **remote protocol** is a low-level debugging interface
-you can use to inspect the state and control execution of documents
-running in web content, instrument the browser in interesting ways,
-simulate user interaction for automation purposes, and for subscribing
-to updates in the browser such as network- or console logs.
+Firefox supports several remote protocols, which allow to inspect and control
+the browser, usually for automation purposes:
 
-It complements the existing Firefox Developer Tools :ref:`Remote Debugging
-Protocol <Remote Debugging Protocol>` (RDP) by implementing a subset of the
-`Chrome DevTools Protocol`_ (CDP).
+* :ref:`marionette-header`
 
-.. _Chrome DevTools Protocol: https://chromedevtools.github.io/devtools-protocol/
+* :ref:`remote-protocol-cdp-header`
 
-.. toctree::
-  :maxdepth: 1
+* :ref:`webdriver-bidi-header`
 
-  Usage.md
-  Prefs.md
 
+Common documentation
+====================
 
-Internals
-=========
+The following documentation pages apply to all remote protocols
 
 .. toctree::
   :maxdepth: 1
 
   Building.md
   Debugging.md
-  Testing.md
-  Architecture.md
   Prefs.md
+  Testing.md
   CodeStyle.md
-  PuppeteerVendor.md
   Security.md
 
 
+.. _marionette-header:
+
+Marionette
+==========
+
+Marionette is used both by internal tools and testing solutions, but also by
+geckodriver to implement the `WebDriver (HTTP) specification`_. The documentation
+for Marionette can be found under `testing/marionette`_.
+
+.. _WebDriver (HTTP) specification: https://w3c.github.io/webdriver/
+.. _testing/marionette: ../testing/marionette/index.html
+
+
+.. _remote-protocol-cdp-header:
+
+Remote Protocol (CDP)
+=====================
+
+Firefox implements a subset of the `Chrome DevTools Protocol`_ (CDP) in order to
+support third party automation tools such as `puppeteer`. The documentation for
+the remote protocol (CDP) implement can be found at `remote/cdp`_.
+
+.. _Chrome DevTools Protocol: https://chromedevtools.github.io/devtools-protocol/
+.. _remote/cdp: cdp/index.html
+
+
+.. _webdriver-bidi-header:
+
+WebDriver BiDi
+==============
+
+`The WebDriver BiDi specification <https://w3c.github.io/webdriver-bidi>`_
+extends WebDriver HTTP to add bidirectional communication. Dedicated
+documentation will be added as the Firefox implementation makes progress.
+
+
 Bugs
 ====
 

remote/doc/cdp/index.rst

@@ -191,7 +191,7 @@ TODO
 Documentation
 -------------
 
-We keep our documentation in-tree under [remote/marionette/doc]
+We keep our documentation in-tree under [remote/doc/marionette]
 and [testing/geckodriver/doc].  Updates and minor changes to
 documentation should ideally not be scrutinised to the same degree
 as code changes to encourage frequent updates so that the documentation
@@ -208,7 +208,7 @@ These include public functions—or command implementations—on
 the `GeckoDriver` class, as well as all exported symbols from
 other modules.  Documentation for non-exported symbols is not required.
 
-[remote/marionette/doc]: https://searchfox.org/mozilla-central/source/remote/marionette/doc
+[remote/doc/marionette]: https://searchfox.org/mozilla-central/source/remote/marionette/doc
 [testing/geckodriver/doc]: https://searchfox.org/mozilla-central/source/testing/geckodriver/doc
 
 

remote/doc/index.rst

@@ -8,8 +8,3 @@ XPCSHELL_TESTS_MANIFESTS += ["test/xpcshell/xpcshell.ini"]
 
 with Files("**"):
     BUG_COMPONENT = ("Testing", "Marionette")
-
-SPHINX_TREES["/testing/marionette"] = "doc"
-
-with Files("doc/**"):
-    SCHEDULES.exclusive = ["docs"]

remote/marionette/doc/Building.md remote/doc/marionette/Building.md

@@ -19,3 +19,4 @@ with Files("doc/**"):
     SCHEDULES.exclusive = ["docs"]
 
 SPHINX_TREES["/remote"] = "doc"
+SPHINX_TREES["/testing/marionette"] = "doc/marionette"

remote/marionette/doc/CodeStyle.md remote/doc/marionette/CodeStyle.md

@@ -35,7 +35,6 @@ codespell:
         - python/mach/docs/
         - python/mozlint/
         - remote/doc/
-        - remote/marionette/doc/
         - security/manager/locales/en-US/
         - services/sync/locales/en-US/
         - taskcluster/docs/