docs: improve arch doc

10 years ago · 253337e55f
parent 514eddcda9
commit 253337e55f
1 changed files with 12 additions and 9 deletions
--- a/ARCHITECTURE.md
+++ b/ARCHITECTURE.md
@ -1,17 +1,19 @@
 # Batarang Architecture

-This document describes the different parts of Batarang and how they interact.
-This is intended for anyone that wants to contribute to or improve Batarang.
+This document describes the different parts of Batarang and how they interact
+with the aim to be useful for anyone that wants to help improve Batarang.


 ## Parts

-### Chrome Devtools Pane
+### Devtools Elements pane
+
+### Devtools Pane
 Dispays stuff


 ### Instrumentation
-Hooks into the app to give you stats and access to the models
+Hooks into the app to give you stats and access to the models.

 ### Background Page
 - Lets us communicate between app and devtools pane
@ -20,12 +22,13 @@ Hooks into the app to give you stats and access to the models

 ## Bootstrap

-How does Batarang start?
+How does Batarang start? When a tab is opened in Chrome:

-1. `manifest.json` – ...
-2. content script
-  - crazy bootstrap
-3. embeds `<script>` into the app's `<head>`
+1. Chrome reads the `manifest.json` – specifically the `content_scripts` field.
+2. content script – `conent-scripts/inject.js`
+  * checks for the presense of an `__ngDebug` cookie
+  * embeds `<script>` into the app's `<head>`
+    - adds a mutation listener
 4. proxy elt
 5. app context patches angular
 6. emits events to content script