Skip to content

Instantly share code, notes, and snippets.

@juliandescottes
Created January 31, 2019 17:11
Show Gist options
  • Save juliandescottes/6bf52cfb0e9ccd5b481375f4b353068e to your computer and use it in GitHub Desktop.
Save juliandescottes/6bf52cfb0e9ccd5b481375f4b353068e to your computer and use it in GitHub Desktop.
Review of existing documentation for remote debugging on MDN
New about:debugging aims to sunset:
- old about:debugging
- WebIDE
- Connect... page
Most documentation pages for those applications screens will have to be updated/modified to describe the experience using the new about:debugging. For WebIDE:
- some features are not going to be in the MVP of the new about:debugging
- some features will not be ported
- some features have already been dropped from WebIDE but are still documented (eg, everything about developping apps or debugging Firefox OS)
About:debugging documentation:
- https://developer.mozilla.org/en-US/docs/Tools/about:debugging will need to be updated with new screenshots
WebIDE documentation:
- Troubleshooting https://developer.mozilla.org/en-US/docs/Tools/WebIDE/Troubleshooting. Should prepare an equivalent for about:debugging new. Some sections are outdated: #Unable_to_load_project_list and #Enable_logging
- homepage https://developer.mozilla.org/en-US/docs/Tools/WebIDE
Outdated, mentions of Firefox OS
- runtimes https://developer.mozilla.org/en-US/docs/Tools/WebIDE/Setting_up_runtimes
Outdated, mentions of Firefox OS, Simulators, and Valence. Points to some dead links `point it to a custom Desktop B2G build`. This section seems useful: https://developer.mozilla.org/en-US/docs/Tools/WebIDE/Setting_up_runtimes#Remote_runtime
- everything should go when we
Connect page:
It looks like we recommend it for debugging Thunderbird: https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging/Thunderbird
Need to get in touch with Thunderbird folks to see if they use it.
Also recommended to debug Firefox Desktop:
https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging/Debugging_Firefox_Desktop
Remote debugging documentation:
- https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging/
- https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging/Debugging_Firefox_Desktop
- https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging/Debugging_Firefox_for_Android_with_WebIDE
- https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging/Debugging_Firefox_for_Android_over_Wifi
Valence documentation: https://developer.mozilla.org/en-US/docs/Tools/Valence has a deprecation notice, but still a lot of details? We should probably remove it, maybe just leave the deprecation notice?
The "Connecting the devtools" section in the "Related Topics" needs updating:
- about:debugging -> is fine
- Connecting to Firefox for Android -> directly points to the WiFi documentation, should probably point to something more generic
- Connecting to iframes -> this is a toolbox feature
- Connecting to other browsers -> we are not supporting this, it should be less visible
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment