MKDocs

docs/README.md

@@ -3,7 +3,7 @@
 <details>
   <summary>:information_source: In the app hover over settings or fields/labels or click blue in-app ❔ (question-mark) icons to get to relevant documentation pages.</summary>
 
-  ![In-app help](/docs/img/GENERAL/in-app-help.png)
+  ![In-app help](./img/GENERAL/in-app-help.png)
 
 </details>
 
@@ -17,7 +17,7 @@ There is also an in-app Help / FAQ section that should be answering frequently a
 
 #### 💻 Bare-metal / On-server (Experimental/community supported 🧪)
 
-- [(Experimental 🧪) On-hardware instructions](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HW_INSTALL.md) 
+- [(Experimental 🧪) On-hardware instructions](./HW_INSTALL.md) 
 
 - Alternative bare-metal install forks: 
   - [leiweibau's fork](https://github.com/leiweibau/Pi.Alert/) (maintained)
@@ -27,58 +27,58 @@ There is also an in-app Help / FAQ section that should be answering frequently a
 
 #### 📥 Initial Setup
 
-- [Synology Guide](/docs/SYNOLOGY_GUIDE.md)
-- [Subnets and VLANs configuration for arp-scan](/docs/SUBNETS.md)
-- [Scanning Remote Networks](/docs/REMOTE_NETWORKS.md)
-- [SMTP server config](/docs/SMTP.md)
-- [Custom Icon configuration and support](/docs/ICONS.md)
-- [Notifications](/docs/NOTIFICATIONS.md)
-- [Better name resolution with Reverse DNS](/docs/REVERSE_DNS.md)
-- [Network treemap configuration](/docs/NETWORK_TREE.md)
-- [Backups](/docs/BACKUPS.md)
+- [Synology Guide](./SYNOLOGY_GUIDE.md)
+- [Subnets and VLANs configuration for arp-scan](./SUBNETS.md)
+- [Scanning Remote Networks](./REMOTE_NETWORKS.md)
+- [SMTP server config](./SMTP.md)
+- [Custom Icon configuration and support](./ICONS.md)
+- [Notifications](./NOTIFICATIONS.md)
+- [Better name resolution with Reverse DNS](./REVERSE_DNS.md)
+- [Network treemap configuration](./NETWORK_TREE.md)
+- [Backups](./BACKUPS.md)
 - [Plugins overview](/front/plugins/README.md)
 
 #### 🐛 Debugging help & tips
 
-- [Debugging tips](/docs/DEBUG_TIPS.md)
-- [Debugging UI not showing](/docs/WEB_UI_PORT_DEBUG.md)
-- [Invalid JSON errors debug help](/docs/DEBUG_INVALID_JSON.md)
-- [Troubleshooting Plugins](/docs/DEBUG_PLUGINS.md)
-- [File Permissions](/docs/FILE_PERMISSIONS.md)
-- [Performance tips](/docs/PERFORMANCE.md)
+- [Debugging tips](./DEBUG_TIPS.md)
+- [Debugging UI not showing](./WEB_UI_PORT_DEBUG.md)
+- [Invalid JSON errors debug help](./DEBUG_INVALID_JSON.md)
+- [Troubleshooting Plugins](./DEBUG_PLUGINS.md)
+- [File Permissions](./FILE_PERMISSIONS.md)
+- [Performance tips](./PERFORMANCE.md)
 
 #### 🔝 Popular/Suggested
 
-- [Home Assistant](/docs/HOME_ASSISTANT.md)
-- [Bulk edit devices](/docs/DEVICES_BULK_EDITING.md)
+- [Home Assistant](./HOME_ASSISTANT.md)
+- [Bulk edit devices](./DEVICES_BULK_EDITING.md)
 
 #### ⚙ System Management
 
-- [Manage devices (legacy docs)](/docs/DEVICE_MANAGEMENT.md)
-- [Random MAC/MAC icon meaning (legacy docs)](/docs/RANDOM_MAC.md)
+- [Manage devices (legacy docs)](./DEVICE_MANAGEMENT.md)
+- [Random MAC/MAC icon meaning (legacy docs)](./RANDOM_MAC.md)
 
 #### 🔎 Examples
 
-- [N8N webhook example](/docs/WEBHOOK_N8N.md)
+- [N8N webhook example](./WEBHOOK_N8N.md)
 
 #### ♻ Misc
 
-- [Version history (legacy)](/docs/VERSIONS_HISTORY.md)
-- [Reverse proxy (Nginx, Apache, SWAG)](/docs/REVERSE_PROXY.md)
-- [Installing Updates](/docs/UPDATES.md)
-- [Setting up Authelia](/docs/AUTHELIA.md) (DRAFT)
+- [Version history (legacy)](./VERSIONS_HISTORY.md)
+- [Reverse proxy (Nginx, Apache, SWAG)](./REVERSE_PROXY.md)
+- [Installing Updates](./UPDATES.md)
+- [Setting up Authelia](./AUTHELIA.md) (DRAFT)
 
 #### 👩‍💻For Developers👨‍💻
 
-- [Setting up your DEV environment](/docs/DEV_ENV_SETUP.md)
+- [Setting up your DEV environment](./DEV_ENV_SETUP.md)
 - [Server APP code structure](/server/README.md)
-- [Database structure](/docs/DATABASE.md)
-- [API endpoints details](/docs/API.md)
-- [Plugin development guide](/docs/PLUGINS_DEV.md)
-- [Settings system](/docs/SETTINGS_SYSTEM.md)
-- [New Version notifications](/docs/VERSIONS.md)
-- [Frontend development tips](/docs/FRONTEND_DEVELOPMENT.md)
-- [Webhook secrets](/docs/WEBHOOK_SECRET.md)
+- [Database structure](./DATABASE.md)
+- [API endpoints details](./API.md)
+- [Plugin development guide](./PLUGINS_DEV.md)
+- [Settings system](./SETTINGS_SYSTEM.md)
+- [New Version notifications](./VERSIONS.md)
+- [Frontend development tips](./FRONTEND_DEVELOPMENT.md)
+- [Webhook secrets](./WEBHOOK_SECRET.md)
 
 Feel free to suggest or submit new docs via a PR. 
 
@@ -137,8 +137,8 @@ Some additional context:
 
 Before submitting a new issue please spend a couple of minutes on research:
 
-* Check [🛑 Common issues](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEBUG_TIPS.md#common-issues) 
+* Check [🛑 Common issues](./DEBUG_TIPS.md#common-issues) 
 * Check [💡 Closed issues](https://github.com/jokob-sk/NetAlertX/issues?q=is%3Aissue+is%3Aclosed) if a similar issue was solved in the past.
-* When submitting an issue ❗[enable debug](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEBUG_TIPS.md)❗
+* When submitting an issue ❗[enable debug](./DEBUG_TIPS.md)❗
 
 ⚠ Please follow the pre-defined issue template to resolve your issue faster.