Bug 1356163 - Devtools: bring over documentation for code directories into the tree. r=pbro draft
authorsole <sole@mozilla.com>
Thu, 13 Apr 2017 10:24:39 +0100
changeset 561961 c21bff2017c6fb0badb34555c74abcd7bbf1460f
parent 561885 1f1c921f172cfb6f299e9ed810b748de6bede180
child 624130 2e05ebe617abac16896a07e5ef9b86817a384050
push id53912
push userbmo:sole@mozilla.com
push dateThu, 13 Apr 2017 09:25:04 +0000
reviewerspbro
bugs1356163
milestone55.0a1
Bug 1356163 - Devtools: bring over documentation for code directories into the tree. r=pbro MozReview-Commit-ID: 4IBkq30uMTQ
devtools/docs/SUMMARY.md
devtools/docs/files/README.md
devtools/docs/files/adding-files.md
devtools/docs/misc/adding-files.md
--- a/devtools/docs/SUMMARY.md
+++ b/devtools/docs/SUMMARY.md
@@ -23,10 +23,10 @@
   * [Debugger API](backend/debugger-api.md)
   * [Backward Compatibility](backend/backward-compatibility.md)
   * Actors
     * [Actors Organization](backend/actor-hierarchy.md)
     * [Handling Multi-Processes in Actors](backend/actor-e10s-handling.md)
     * [Writing Actors With protocol.js](backend/protocol.js.md)
     * [Registering A New Actor](backend/actor-registration.md)
     * [Actor Best Practices](backend/actor-best-practices.md)
-* Miscellaneous
-  * [Adding New Files](misc/adding-files.md)
+* [Files and directories](files/README.md)
+  * [Adding New Files](files/adding-files.md)
new file mode 100644
--- /dev/null
+++ b/devtools/docs/files/README.md
@@ -0,0 +1,13 @@
+# Directories Overview
+
+This page provides a very top level overview of what is on each directory in the DevTools source code:
+
+* `devtools/shared`: Code shared by both the client (front-end UI) and server. If we are using any third party libraries, or importing external repositories into our tree, those libraries generally live here (eg, `devtools/shared/acorn`), assuming they are used by both client and server.
+  * `devtools/shared/client`: Code for the [Remote Debugging Protocol](../backend/protocol.md) (RDP) client. You may wonder why this is not in `devtools/client` below: it's mainly because tests in server also need access to the RDP client.
+  * `devtools/shared/locales`: Strings used in either the server only, or shared with both the client and server.
+* `devtools/server`: Code for the [RDP](../backend/protocol.md) server and transport layer.
+  * `devtools/server/actors`: [RDP Actors](../backend/protocol.md#actors). Note that if you're modifying actors, you may need to worry about [backwards compatibility](../backend/backwards-compatibility.md) with older clients.
+* `devtools/client`: Code for the front-end side of our tools. In theory, each directory corresponds to a panel, but this is not always the case. This directory is only shipped with desktop Firefox, as opposed to other directories above, which are shipped with all Gecko products (Firefox for Android, etc.)
+  * `devtools/client/locales`: Strings used in the client front-end.
+  * `devtools/client/themes`: CSS and images used in the client front-end.
+
rename from devtools/docs/misc/adding-files.md
rename to devtools/docs/files/adding-files.md