📚Docs

jokob-sk · Jun 27, 2024 · 90038f1 · 90038f1
1 parent 63a922e
commit 90038f1
Show file tree

Hide file tree

Showing 24 changed files with 23 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -15,6 +15,8 @@ Get visibility of what's going on on your WIFI/LAN network. Schedule scans for d
   | ![Main screen][main] | ![Screen 1][screen1]  | ![Screen 5][screen5] |
   |----------------------|----------------------| ----------------------| 
 
+  ![network_setup][network_setup] 
+
 <details>
   <summary>📷 Click for more screenshots</summary>
 
@@ -132,19 +134,20 @@ Help out and suggest languages in the [online portal of Weblate](https://hosted.
 
 
 <!--- --------------------------------------------------------------------- --->
-[main]:    ./docs/img/devices_split.png                   "Main screen"
-[screen1]: ./docs/img/device_details.png                  "Screen 1"
-[screen2]: ./docs/img/events.png                          "Screen 2"
-[screen3]: ./docs/img/presence.png                        "Screen 3"
-[screen4]: ./docs/img/maintenance.png                     "Screen 4"
-[screen5]: ./docs/img/network.png                         "Screen 5"
-[screen6]: ./docs/img/settings.png                        "Screen 6"
-[screen7]: ./docs/img/help_faq.png                        "Screen 7"
-[screen8]: ./docs/img/plugins_rogue_dhcp.png              "Screen 8"
-[screen9]: ./docs/img/device_nmap.png                     "Screen 9"
-[report1]: ./docs/img/4_report_1.jpg                      "Report sample 1"
-[report2]: ./docs/img/4_report_2.jpg                      "Report sample 2"
-[main_dark]: /docs/img/1_devices_dark.jpg                 "Main screen dark"
-[maintain_dark]: /docs/img/5_maintain.jpg                 "Maintain screen dark"
-[follow_star]: /docs/img/Follow_Releases_and_Star.gif     "Follow and Star"
+[main]:           ./docs/img/devices_split.png                   "Main screen"
+[screen1]:        ./docs/img/device_details.png                  "Screen 1"
+[screen2]:        ./docs/img/events.png                          "Screen 2"
+[screen3]:        ./docs/img/presence.png                        "Screen 3"
+[screen4]:        ./docs/img/maintenance.png                     "Screen 4"
+[screen5]:        ./docs/img/network.png                         "Screen 5"
+[screen6]:        ./docs/img/settings.png                        "Screen 6"
+[network_setup]:  ./docs/img/network_setup.gif                  "Screen 6"
+[screen7]:        ./docs/img/help_faq.png                        "Screen 7"
+[screen8]:        ./docs/img/sync_hub.png                        "Screen 8"
+[screen9]:        ./docs/img/device_nmap.png                     "Screen 9"
+[report1]:        ./docs/img/4_report_1.jpg                      "Report sample 1"
+[report2]:        ./docs/img/4_report_2.jpg                      "Report sample 2"
+[main_dark]:      /docs/img/1_devices_dark.jpg                 "Main screen dark"
+[maintain_dark]:  /docs/img/5_maintain.jpg                 "Maintain screen dark"
+[follow_star]:    /docs/img/Follow_Releases_and_Star.gif     "Follow and Star"
 
diff --git a/docs/img/2_4_device_nmap.jpg b/docs/img/2_4_device_nmap.jpg
diff --git a/docs/img/2_5_device_nmap_ready.jpg b/docs/img/2_5_device_nmap_ready.jpg
diff --git a/docs/img/device_details.png b/docs/img/device_details.png
diff --git a/docs/img/device_nmap.png b/docs/img/device_nmap.png
diff --git a/docs/img/devices_dark.png b/docs/img/devices_dark.png
diff --git a/docs/img/devices_light.png b/docs/img/devices_light.png
diff --git a/docs/img/devices_split.png b/docs/img/devices_split.png
diff --git a/docs/img/events.png b/docs/img/events.png
diff --git a/docs/img/help_faq.png b/docs/img/help_faq.png
diff --git a/docs/img/maintenance.png b/docs/img/maintenance.png
diff --git a/docs/img/multi_edit.png b/docs/img/multi_edit.png
diff --git a/docs/img/network.png b/docs/img/network.png
diff --git a/docs/img/network_setup.gif b/docs/img/network_setup.gif
diff --git a/docs/img/notification_center.png b/docs/img/notification_center.png
diff --git a/docs/img/plugins.png b/docs/img/plugins.png
diff --git a/docs/img/plugins_device_details.png b/docs/img/plugins_device_details.png
diff --git a/docs/img/plugins_rogue_dhcp.png b/docs/img/plugins_rogue_dhcp.png
diff --git a/docs/img/plugins_webmon.png b/docs/img/plugins_webmon.png
diff --git a/docs/img/presence.png b/docs/img/presence.png
diff --git a/docs/img/sent_reports_text.png b/docs/img/sent_reports_text.png
diff --git a/docs/img/settings.png b/docs/img/settings.png
diff --git a/docs/img/sync_hub.png b/docs/img/sync_hub.png
diff --git a/front/plugins/README.md b/front/plugins/README.md
@@ -1,10 +1,15 @@
 # 🔌 Plugins
 
+NetAlertX supports additional plugins to extend its functionality, each with its own settings and options. Plugins can be loaded via the General -> `LOADED_PLUGINS` setting by using Ctrl + Click. For custom plugin development, refer to the [Plugin development guide](/docs/PLUGINS_DEV.md).   
+
 >[!NOTE]
 > Please check this [Plugins debugging guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEBUG_PLUGINS.md) and the corresponding Plugin documentation in the below table if you are facing issues.  
 
 ## ⚡ Quick start
 
+> [!TIP]
+> You can load additional Plugins via the General -> `LOADED_PLUGINS` setting. Use `Ctrl + Click` to select/deselect. 
+
 1. Pick your `🔍 dev scanner` plugin (e.g. `ARPSCAN` or `NMAPDEV`), or import devices into the application with an `📥 importer` plugin. (See **✅Enabling plugins** below)
 1. Pick a `▶️ publisher` plugin, if you want to send notifications. If you don't see a publisher you'd like to use, look at the  [📚_publisher_apprise](/front/plugins/_publisher_apprise/) plugin which is a proxy for over 80 notification services. 
 1. Setup your [Network topology diagram](/docs/NETWORK_TREE.md)