Bug 1755529 - [devtools] Add some documentation for debugger bin/bundle artifacts r=nchevobbe

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

devtools/client/debugger/bin/bundle.js

@@ -23,6 +23,20 @@ function moveFile(src, dest) {
   rimraf.sync(src);
 }
 
+/**
+ * The `bundle` module will build the following:
+ * - vendors.js and vendors.css:
+ *     Bundle for all the external packages still used by the Debugger frontend.
+ *     Source at devtools/client/debugger/src/vendors.js
+ * - parser-worker.js, pretty-print-worker.js, search-worker:
+ *     Workers used only by the debugger.
+ *     Sources at devtools/client/debugger/src/workers/*
+ * - source-map-index and source-map-worker:
+ *     Entry point and worker for handling source-maps used both by the debugger
+ *     and the rest of DevTools. Built from the devtools-source-map package, the
+ *     generated files are moved to devtools/client/shared/source-map and
+ *     usually provided by the toolbox.
+ */
 (async function bundle() {
   process.env.TARGET = "firefox-panel";
   process.env.OUTPUT_PATH = bundlePath;

devtools/client/shared/source-map/README

@@ -1,12 +1,10 @@
-devtools-source-map is maintained on GitHub at:
+THIS FOLDER ONLY CONTAINS GENERATED FILES, NEVER UPDATE MANUALLY!
 
-https://github.com/firefox-devtools/debugger.html/tree/master/packages/devtools-source-map
+The source files for the source-map shared helpers can be found under
 
-All the files in this folder are copied from the above repository and
-should not be modified here.
+  devtools/client/debugger/packages/devtools-source-map
 
-For any issue or feature request on devtools-source-map, please log an issue at:
+After modifying the sources in debugger/packages/devtools-source-map, regenerate
+the files in this folder by running:
 
-https://github.com/firefox-devtools/debugger.html/issues
-
-and label it with "devtools-source-map".
+  `yarn && node devtools/client/debugger/bin/bundle.js`