chore: migrate docs to zensical from mkdocs & improve clarity (#7634)

* chore: touch-up sentences

* test

* messing around w/ workflows

* update some more notes

* updated more notes + quick fixes

* quick clarification

* swap role of note on Abstract

* changed my mind, LMFAO, make it a tip

* update requirements.txt

Author: userandaname

.github/workflows/deploy-docs.yml

@@ -15,10 +15,24 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
       - uses: actions/setup-python@v5
         with:
           python-version: 3.x
-      - run: pip install --upgrade pip
-      - run: pip install --upgrade setuptools wheel
-      - run: pip install mkdocs mkdocs-material mkdocs-print-site-plugin pymdown-extensions
-      - run: mkdocs gh-deploy --force
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install zensical mkdocs-material mkdocs-print-site-plugin pymdown-extensions
+
+      - name: Build with Zensical
+        run: zensical build
+
+      - name: Deploy to Pages branch
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/site
+          publish_branch: gh-pages

docs/.gitignore

@@ -0,0 +1,2 @@
+/site 
+# ^ zensical's build directory

docs/docs/design/index.md

@@ -2,23 +2,15 @@
 
 ![](images/2022-05-15-12-57-36.jpg)
 
-## 🎬 Video Walkthru
+## 🎬 Video Walkthrough
 
 <div class="video-wrapper">
   <iframe src="https://www.youtube.com/embed/MOQ0uCUs7_M" frameborder="0" allowfullscreen></iframe>
 </div>
 
 ## 🧾 Abstract
 
-This  document  attempts  to  describe  the  architecture  and  design  of  the  second  version  of MeshCentral on which work started in late 2016. The document covers the overview of the design, goes in details about the protocol and various decisions and trade-offs. This document is intended for anyone that wants to understand the inner workings of MeshCentral or someone that wants to make a security review of the software. 
-
----
-> **📌 Note :**
-
-> The software and added documentation and tutorial videos are available at :
-[ https://www.meshcommander.com/meshcentral2 ](https://www.meshcommander.com/meshcentral2)
-
----
+This document goes over the architecture and design of the second version of MeshCentral, on which work started in late 2016, and covers the overview of the design, as well as providing details about the protocol and various decisions and trade-offs. This document is intended for anyone that wants to understand the inner workings of MeshCentral or someone that wants to make a security review of the software. 
 
 ## 📘 Introduction
 
@@ -30,7 +22,7 @@ The advent of NodeJS, WebSocket, WebRTC and other web technologies coming out in
 
 The goal of MeshCentral is to be the best open source remote management software in the world. Remote computer management is a big area with many different usages and requirements. To best suite this, it’s important to have software that is as flexible as possible.
 
-Additionally, there are many other goals : 
+Additionally, there are many other goals: 
 
   > - **Must be quick and easy to install.** 
   > - **Must install on all major operating systems and platforms.** 
@@ -72,7 +64,7 @@ Another interesting design decision is that MeshCentral makes almost no use of R
 
 ## 🗄️ MeshCentral server
 
-The MeshCentral server is a NodeJS application that is published on NPM at : [https://www.npmjs.com/package/meshcentral](https://www.npmjs.com/package/meshcentral) Many administrators can get started quickly using “npm install meshcentral” once NodeJS is installed. MeshCentral will work on Node 6.x and higher. 
+The MeshCentral server is a NodeJS application that is published on NPM at : [https://www.npmjs.com/package/meshcentral](https://www.npmjs.com/package/meshcentral) Many administrators can get started quickly using `npm install meshcentral` once NodeJS is installed. MeshCentral will work on Node 6.x and higher. 
 
 ## 📦 Dependencies
 
@@ -368,7 +360,7 @@ A unique feature of MeshCentral is its use of WebRTC. WebRTC was introduced in m
 
 The use of WebRTC allows MeshCentral to scale better, to offer a faster user experience and lower hosting costs all at the same time. However, WebRTC is not easy, especially when you must maintain the C code for it and have to keep up with browser implementations, but the benefits are clear. 
 
-To setup WebRTC, browsers typically use STUN and TURN servers to get traffic thru any network obstacles (routers, proxies, firewalls). This infrastructure can be complex to setup especially if an administrator is not familiar with WebRTC concepts. To make things easy, MeshCentral opted to always start by using a websocket relay thru the server to get things started. While a session is active, the browser and agent will attempt to automatically switch the session traffic to WebRTC when possible. This way, the session always works and gets more efficient when network conditions allow. 
+To setup WebRTC, browsers typically use STUN and TURN servers to get traffic through any network obstacles (routers, proxies, firewalls). This infrastructure can be complex to setup especially if an administrator is not familiar with WebRTC concepts. To make things easy, MeshCentral opted to always start by using a websocket relay through the server to get things started. While a session is active, the browser and agent will attempt to automatically switch the session traffic to WebRTC when possible. This way, the session always works and gets more efficient when network conditions allow. 
 
 To perform the switch-over, both browser and agent will exchange WebRTC control messages over the newly established web socket relay session. 
 

docs/docs/index.md

@@ -1,10 +1,11 @@
 # MeshCentral Documentation
 
-## About
+## ❓ About
 
-MeshCentral is a full computer management web site. With MeshCentral, you can run your own web server to remotely manage and control computers on a local network or anywhere on the internet. Once you get the server started, create device group and download and install an agent on each computer you want to manage. A minute later, the new computer will show up on the web site and you can take control of it. MeshCentral includes full web-based remote desktop, terminal and file management capability.
+MeshCentral is a versatile, open-source computer management platform. By hosting your own MeshCentral server, you can remotely manage computers from anywhere in the world. The platform provides a seamless, web-based experience for remote desktop access, terminal control, and file management.
 
-For more information, [visit MeshCentral.com](https://meshcentral.com).
+!!! tip
+    For more information, [visit MeshCentral.com](https://meshcentral.com).
 
 ## 🌐 Social Media
 
@@ -53,15 +54,15 @@ Use **MeshCentral Router** to **port map TCP connections** securely.
 
 ## 💬 Feedback
 
-If you encounter a problem or have a suggestion to improve the product, you may file an [GitHub Issue](https://github.com/Ylianst/MeshCentral/issues/).<br>
+If you encounter a problem or have a suggestion to improve MeshCentral, you may want to create a [GitHub issue](https://github.com/Ylianst/MeshCentral/issues/).<br>
 If you are filing a problem report, you should include:
 
-* The version of the software you are using.
-> For example: 1.1.46
-* The Operating System and version.
-> For example: Debian 12
+* The version of MeshCentral you are using.
+> For example: v1.1.56.
+* The operating system and its version.
+> For example: Debian 12.
 * Any troubleshooting you took to resolve the issue yourself.
-> For example: Reinstalling MeshCentral (including OS)
+> For example: Reinstalling MeshCentral. (and your OS!)
 * Any other similar reports.
 > For example: other GitHub issues.
 * The observed output.

docs/docs/install/container.md

@@ -37,10 +37,8 @@ All master tags below follow the master branch of MeshCentral, the latest and ve
 | `1.1.51-postgresql` and `latest-postgresql` | Docker image with the PostgreSQL packages installed. |
 | `1.1.51-mysql` and `latest-mysql` | Docker image with the MySQL packages installed. |
 
----
-> **📌 Note:**
-Refer to [this page](https://github.com/Ylianst/MeshCentral/pkgs/container/meshcentral) for more information on the container status.
----
+!!! note
+    Refer to [this page](https://github.com/Ylianst/MeshCentral/pkgs/container/meshcentral) for more information on the container status.
 
 ## 🐋 Docker/Podman
 

docs/docs/install/security/crowdsec.md

@@ -2,7 +2,7 @@
 
 MeshCentral has built-in support for a CrowdSec bouncer. This allows MeshCentral to get threat signals from the community and block or CAPTCHA requests coming from known bad IP addresses.
 
-## 🎬 Video Walkthru
+## 🎬 Video Walkthrough
 
 <div class="video-wrapper">
   <iframe width="320" height="180" src="https://www.youtube.com/embed/TVKF9gBJFCE" frameborder="0" allowfullscreen></iframe>

docs/docs/intelamt/index.md

@@ -3,7 +3,7 @@
 
 Intel AMT Guide [as .odt](../documents/MeshCentral%20Intel%20AMT%20Guide%20v0.0.1.odt)
 
-## Video Walkthru
+## Video Walkthrough
 
 <div class="video-wrapper">
   <iframe width="320" height="180" src="https://www.youtube.com/embed/naWKE3rT6e8" frameborder="0" allowfullscreen></iframe>
@@ -81,7 +81,7 @@ If the MeshCentral server is setup in “LAN mode” or “Hybrid mode”, optio
 
 Client Initiated Remote Access (CIRA) is a feature of Intel AMT that, then configured, makes Intel AMT connect back to the server using a TLS tunneling connection similar with a SSH tunnel. Once this tunnel connection is established, the server can perform remote management operations on Intel AMT.
 
-CIRA is great when remotely managing Intel AMT devices over the Internet thru network address translator (NAT) routers where the server would not be able to connect to Intel AMT. This is similar to the Mesh Agent that initiated and keeps an idle connection to the server.
+CIRA is great when remotely managing Intel AMT devices over the Internet through network address translator (NAT) routers where the server would not be able to connect to Intel AMT. This is similar to the Mesh Agent that initiated and keeps an idle connection to the server.
 
 By default, MeshCentral will be configured to receive Mesh Agent connections on TCP port 443 and Intel AMT connections on TCP port 4433. These port values can be configured in the config.json file of MeshCentral.