devtools/docs/index.rst

   1 =================================
   2 Firefox DevTools Contributor Docs
   3 =================================
   4
   5 This is a guide to working on the code for Firefox Developer Tools. If you're looking for help with using the tools, see the `user docs <https://developer.mozilla.org/en-US/docs/Tools>`__. For other ways to get involved, check out our `community site <https://firefox-dev.tools/>`__.
   6
   7
   8 Getting Started
   9 ===============
  10 .. toctree::
  11    :maxdepth: 1
  12
  13    Getting Started <getting-started/README.md>
  14    Get a Bugzilla account <getting-started/bugzilla.md>
  15    Create a development profile <getting-started/development-profiles.md>
  16
  17
  18 Contributing
  19 ============
  20 .. toctree::
  21    :maxdepth: 1
  22
  23    Contributing <contributing.md>
  24    Find bugs to work on <contributing/find-bugs.md>
  25    How to fix a bug <contributing/fixing-bugs.md>
  26    Code reviews <contributing/code-reviews.md>
  27    Landing code <contributing/landing-code.md>
  28    Leveling up <contributing/levelling-up.md>
  29    Coding standards <contributing/coding-standards.md>
  30    Filing good bugs <contributing/filing-good-bugs.md>
  31    Investigating performance issues <contributing/performance.md>
  32    Writing efficient React code <contributing/react-performance-tips.md>
  33
  34
  35 Automated tests
  36 ===============
  37 .. toctree::
  38    :maxdepth: 1
  39
  40    Automated tests <tests/README.md>
  41    xpcshell <tests/xpcshell.md>
  42    Chrome mochitests <tests/mochitest-chrome.md>
  43    DevTools mochitests <tests/mochitest-devtools.md>
  44    Node tests <tests/node-tests.md>
  45    Writing tests <tests/writing-tests.md>
  46    Debugging intermittent failures <tests/debugging-intermittents.md>
  47    Performance tests (DAMP) <tests/performance-tests.md>
  48    Writing a new test <tests/writing-perf-tests.md>
  49    Example <tests/writing-perf-tests-example.md>
  50    Advanced tips <tests/writing-perf-tests-tips.md>
  51
  52 Files and directories
  53 =====================
  54 .. toctree::
  55    :maxdepth: 1
  56
  57    Files and directories <files/README.md>
  58    Adding New Files <files/adding-files.md>
  59
  60
  61 Tool Architectures
  62 ==================
  63 .. toctree::
  64    :maxdepth: 1
  65
  66    Inspector Panel Architecture <tools/inspector-panel.md>
  67    Inspector Highlighters <tools/highlighters.md>
  68    Memory <tools/memory-panel.md>
  69    Debugger <tools/debugger-panel.md>
  70    Responsive Design Mode <tools/responsive-design-mode.md>
  71    Console <tools/console-panel.md>
  72    Network </devtools/netmonitor/architecture.md>
  73
  74
  75 Frontend
  76 ========
  77 .. toctree::
  78    :maxdepth: 1
  79
  80   Panel SVGs <frontend/svgs.md>
  81   React <frontend/react.md>
  82   React Guidelines <frontend/react-guidelines.md>
  83   Redux <frontend/redux.md>
  84   Redux Guidelines <frontend/redux-guidelines.md>
  85   Telemetry <frontend/telemetry.md>
  86   Content Security Policy <frontend/csp.md>
  87
  88
  89 Backend
  90 =======
  91 .. toctree::
  92    :maxdepth: 1
  93
  94    Remote Debugging Protocol <backend/protocol.md>
  95    Client API <backend/client-api.md>
  96    Debugger API <backend/debugger-api.md>
  97    Backward Compatibility <backend/backward-compatibility.md>
  98    Actors Organization <backend/actor-hierarchy.md>
  99    Handling Multi-Processes in Actors <backend/actor-e10s-handling.md>
 100    Writing Actors With protocol.js <backend/protocol.js.md>
 101    Registering A New Actor <backend/actor-registration.md>
 102    Actor Best Practices <backend/actor-best-practices.md>
 103
 104 Preferences
 105 ===========
 106 .. toctree::
 107    :maxdepth: 1
 108
 109    Preferences <preferences.md>