Final polish

docs/contributing/contributing.md

@@ -2,4 +2,4 @@
 # Contributing
 
 !!! example "Still brewing!"
-    Sorry, we haven't *quite* gotten around to writing this set of articles just yet. **In the meantime, feel free to hit us up on [Discord](https://discord.gg/AHcCbXbEcF).**
+    Sorry, we haven't *quite* gotten around to writing this set of articles just yet. **In the meantime, feel free to hit us up on [Discord](https://discord.gg/OpenShock).**

docs/diy/selfhosting.md

@@ -2,4 +2,4 @@
 # Self-hosting
 
 !!! example "Still brewing!"
-    Sorry, we haven't *quite* gotten around to writing this set of articles just yet. **In the meantime, feel free to hit us up on [Discord](https://discord.gg/AHcCbXbEcF).**
+    Sorry, we haven't *quite* gotten around to writing this set of articles just yet. **In the meantime, feel free to hit us up on [Discord](https://discord.gg/OpenShock).**

docs/guides/openshock-first-setup.md

@@ -9,77 +9,78 @@
 - USB cable suitable for your device.
 - A stable power source. Try to avoid cheap power bricks, they can cause the device to crash under certain loads.
 - A smartphone with a web browser (Chrome, Firefox etc.)
-- [ESP Device](../hardware/boards/index.md)
+- [OpenShock hub](../hardware/boards/index.md)
 - [Shocker](../hardware/shockers/index.md)
 - [Shocklink account](https://shocklink.net/)
 
-## Setup the ESP Device
+## Setup the OpenShock hub
 
-1. Connect your **Phone** to the ESP:
-    1. Plug your device in and grab your **phone**.
+1. Connect your **Phone** to the hub:
+    1. Plug your hub in and ensure it has power.
     2. On your phone, search for a Wi-Fi network named similar to ``Openshock-24:DC:C3:9F:72:C8`` and connect to it.  
     ??? Info "Image"
         ![Image "image"](../static/guides/first-setup/WiFioverview.png)
-2. Connect the device to your Wi-Fi network:
-    1. Open your phone's browser and type in ``10.10.10.10`` *or* ``openshock.local`` this should open up a web-interface for the device.
-    2. Find your routers Wi-Fi Network in the web-interface, press the green button next to it and type in your Wi-Fi password then press submit.
-    *A green message should pop up if it's connected*
+2. Connect to the hub via the network:
+    1. Open your phone's browser and type in ``10.10.10.10`` *or* ``openshock.local`` this should open up a web-interface for the hub.
+    2. Find your router's Wi-Fi network in the web-interface.
+    3. Press the green button next to it and type in your Wi-Fi password, then press submit.
+    *A green pop up should appear if it's connected successfully*
     ??? Info "Image"
         ![Image "image"](../static/guides/first-setup/ESPWebGUI.png)
-3. Create a Device on the website:
+3. Create a hub on the website:
     1. **On your PC** open [Shocklink.net](https://shocklink.net/).
     2. Create an account. *(If you don't have one already)*
-    3. Go to **Devices** and click the **green plus icon** at the lower right corner to create a new device.
+    3. Go to **Devices** and click the **green plus icon** at the lower right corner to create a new hub.
     4. Give it a name:
-        1. Open the Context menu of the device. *(the three dots next to your newly created device)*
+        1. Open the context menu of the hub. *(the three dots next to the newly created hub)*
         2. Select **edit**.
-        3. Type in the name for the ESP *(your name for example)* into the name field.
+        3. Type in a name, *(your name for example)* into the name field.
         4. Press save.
     ??? Info "Images"
         ![Image "image"](../static/guides/first-setup/findaddbutton3.png)
         ![Image "image"](../static/guides/first-setup/find_device_context_menu.png)
         ![Image "image"](../static/guides/first-setup/edit_device.png)
-4. Pair the Device:
-    1. Open the Context Menu of your device again.
+4. Pair the hub:
+    1. Open the context menu of your hub again.
     2. Select **pair** and press **get pair code**, this will generate a new pair code.
-    3. On your Phone type the code into the Account Linking field of the ESP's web-interface, then press **pair**
-        - After you linked the Device to your account it should shut down it's own Wi-Fi network.
+    3. On your phone type the code into the account Linking field of the hub's web-interface, then press **pair**.
+        - After you linked the hub to your account it should shut down it's own Wi-Fi network.
     ??? Info "Images"
         ![Image "image"](../static/guides/first-setup/findpaircode.png)
         ![Image "image"](../static/guides/first-setup/paircodeexample.png)
-5. The setup of the Device itself is done. yay! 🎉
-    - If everything went well it should show a **green icon** next to the device name on the website.
+5. The hub is now connected!
+    - If everything went well, it should show a **green icon** next to the device name on the website.
     ??? Info "Image"
         ![Image "image"](../static/guides/first-setup/checkifonline.png)
 !!! warning "RF TX Pin"
-    **DO NOT** change the RF TX Pin, this is an advanced feature. It should be set correctly by default after flashing the OpenShock firmware. For more information see [boards](../hardware/boards/index.md).
+    **DO NOT** change the RF TX Pin, this is an advanced feature. It should be set correctly by default after flashing the OpenShock firmware. For more information see the page dedicated to your micro-controller under [boards](../hardware/boards/index.md).
 
 ## Pair a shocker
 
-1. Make sure you charged the shocker first.
-2. Make sure your Device is connected to the website. ([Setup Device](#setup-the-esp-device))
+1. Ensure the shocker is sufficiently charged.
+2. Ensure your hub is connected to the website. ([Setup the OpenShock hub](#setup-the-openshock-hub))
 3. Create a Shocker.
     1. Go to [Shocklink.net](https://shocklink.net/)
-    2. login if you are not logged in already.
+    2. Login if you are not already.
     3. Navigate to **Shockers**.
-    4. Press the green **+** icon at the bottom right corner.
-    5. Select your earlier created **device**.
-    6. Give it a **name**.
+    4. Press the **green plus icon** at the bottom right corner.
+    5. Select the hub you created earlier.
+    6. Give your new shocker a name.
     7. Select the **model** of shocker.
-    8. Click **create**.
+    8. Click **Create**
     ??? info "Images"
         ![image](../static/guides/first-setup/Create_shocker_green_plus.png)
         ![image](../static/guides/first-setup/create_shocker.png)
 4. Pair your Shocker.
     1. Grab your shocker and turn it on. (Hold the power button for 1 sec. it should beep once.)
     2. Hold the power button again until it beeps and the LED flashes fast. *This means the pair mode is active*
-    3. On the website click the _**Speaker icon**_ of your shocker, if your shocker now makes a sound, the pairing was successful.
+    3. On the website click the ***speaker icon*** of your shocker, if your shocker now makes a sound, the pairing was successful.
     ??? Info "Image"
         ![image](../static/guides/first-setup/find_sound_button.png)
 **Everything should work now, have fun!** 🎉  
 
 !!! question "Need Help?"
-    If you need additional help, join our [Discord](https://shocklink.net/discord)
+    If you need additional help, join our [Discord](https://discord.gg/OpenShock)
 
 !!! Info
-    Your shocker will remember the Device, no need to pair it every time.
+    Your shocker will remember the device, there is no need to pair it every time.

docs/guides/openshock-how-to-flash-your-board.md

@@ -2,27 +2,25 @@
 
 ## What you need
 
-- [ESP (Device)](../hardware/boards/index.md)
-- A Chromium based browser like Google Chrome for example. **Firefox will not work since it doesn't support Web Serial**
+- [OpenShock hub](../hardware/boards/index.md)
+- A Chromium based web-browser (Chrome, Edge, Opera, etc.) **Firefox will not work since it doesn't support Web Serial**
 - [Our Flashtool](https://next.shocklink.net/flashtool)
 
 !!! warning "Important"
-    Make sure you have a cable that supports data transfer.  
-    Make sure your cable is not damaged.  
-    Make sure your USB port is not damaged.
+    Ensure you have a cable that supports data transfer, and neither the port nor cable is damaged.
 
 ## Flashing the firmware
 
-1. Plug your Device into your PC using a USB cable.
-2. Open the [Flashtool](https://next.shocklink.net/flashtool) with Chrome or another Chromium based browser.
-3. Click "Select Device" and select your Device in the Popup window.  
+1. Plug your hub into your PC using a USB cable.
+2. Open the [Flashtool](https://next.shocklink.net/flashtool).
+3. Click "Select Device" and select your hub in the Popup window.  
 If your Device is not showing up click on "Install Drivers", after that repeat this step.
-![Connect Device](../static/guides/how-to-flash/Connect_Device_Flashtoolguide.png)
-4. Make sure you have the "Stable" channel selected.
-5. Make sure the correct board is selected.
+![Connect Controller](../static/guides/how-to-flash/Connect_Device_Flashtoolguide.png)
+4. Ensure you have the "Stable" channel selected.
+5. Ensure the correct board is selected.
 ![Settings](../static/guides/how-to-flash/settings.png)  
-6. Press Flash and let it do it's thing, keep the window open it'll tell you when it's done.  
-7. When everything went well you board will restart and you should be able to run through the [First Setup](../guides/openshock-first-setup.md) steps to configure your Device and link it to your shocker etc.  
+6. Press Flash and let it do it's thing, keep the window open and it will tell you when it's done.  
+7. When everything went well you board will restart and you should be able to run through the [First Setup](../guides/openshock-first-setup.md) steps to configure your hub and link it to your shocker etc.  
 8. (Optional) If you have issues after flashing it try again with "Erase everything before flashing" enabled.  
 
 !!! failure "Still not working?"

docs/guides/openshock-how-to-update.md

@@ -9,23 +9,23 @@
 ## Over the Air Update (Recommended)
 
 1. Login to the [website](https://shocklink.net/)
-2. Connect your Device to a power source and make sure it appears as Online in the Device section.
-3. Open the context menu of your Device.
+2. Connect your hub to a power source and make sure it appears as online in the Device section.
+3. Open the context menu of your hub.
 4. Select "OTA Update".  
 ![Open OTA](../static/guides/how-to-update/update-Open-OTA.png)  
 5. Now you can see 3 different branches of firmware, these are "Develop", "Stable" and "Beta". **We recommend that you only use the Stable branch if you don't know what you're doing.**
 6. If your firmware version is older than the one displayed on the "Stable" button, you should update.  
 ![Update Window](../static/guides/how-to-update/update-Window.png)  
 7. Click the "Stable" button.
-8. Confirm the Update.
-9. Your Device should now update automatically, don't close the website during this.  
-After it's done it should restart your Device and everything should just work™.
+8. Confirm the update.
+9. Your hub should now update automatically, don't close the website during this.  
+After it has completed the hub should restart and everything should just work™.
 
 !!! failure "What if something fails?"
-    If the update is not successful the updater will not overwrite anything and your Device should just stay on the old version.  
+    If the update is not successful the updater will not overwrite anything and your hub should just stay on the old version.  
     Ask on the [Discord](https://discord.gg/OpenShock) for help.
 
 ## Using a Flash tool
 
-This basically means re-flashing your firmware with a newer version, like it is explained in the [How to flash the firmware](../guides/openshock-how-to-flash-your-board.md) guide.  
+This basically means re-flashing your firmware with a newer version, like it is explained in the [How to flash the firmware](../guides/openshock-how-to-flash-your-board.md) guide.
 **Doing it this way will also reset all your configuration.**

docs/guides/shocklink-sharecodes.md

@@ -9,7 +9,7 @@
 ## What you need
 
 - [Shocklink.net account](https://shocklink.net/)
-- [A working shocker](openshock-first-setup.md)
+- [A connected shocker](openshock-first-setup.md)
 
 ## Create a share code
 

docs/guides/shocklink-sharelinks.md

@@ -6,7 +6,7 @@
 ## What you need
 
 - [Shocklink.net account](https://shocklink.net/)
-- [A working shocker](openshock-first-setup.md)
+- [A connected shocker](openshock-first-setup.md)
 
 ## How to create a Share link
 
@@ -35,7 +35,7 @@
         ![Image "Image"](../static/guides/how-to-sharelinks/addshockertosharelink2.png)  
 
 **That's it.**  
-Everyone you send the share link to can now control your shocker. 🎉  
+Everyone you send the share link to can now control your shocker. 🎉
 
 !!! Tip
     Create multiple share links for different people to have better control over who can shock you!

docs/guides/shockosc-avatar-setup-cvr.md

@@ -2,12 +2,12 @@
 
 ## What you need
 
-- [ShockOsc](shockosc-basic.md)
+- [ShockOSC](shockosc-basic.md)
 - A ChilloutVR avatar
 - Basic experience in working with ChilloutVR avatars is recommended  
 - A OSC mod for ChilloutVR
 
-!!! Info "Special ShockOsc Settings for ChilloutVR"
+!!! Info "Special ShockOSC Settings for ChilloutVR"
     Please make sure you have "OSC Query" turned off in the **App Settings** tab.  
 
 ## Touch Trigger
@@ -27,7 +27,7 @@
 5. That's it. 🎉  
 
 ## List of available parameters
-
+<!-- markdownlint-disable MD046 -->
 === "Avatar Dynamic Parameters "
     !!! Info "``ShockOsc/{GroupName}`` (bool)"
         when set to ``true`` and held, will trigger a normal shock in ShockOSC
@@ -52,7 +52,7 @@
     !!! Info "``ShockOsc/{GroupName}_CooldownPercentage`` (float)"
         Reads out the shocker cooldown, 1 means cooldown and 0 means no cooldown.
         can be used to make a cooldown timer for example.  
-        
+
     !!! Info "``ShockOsc/{GroupName}_Intensity``  (float)"
         represents how close the shock was to your configured max intensity.
 
@@ -67,7 +67,7 @@
 
 === "Config Parameters"  
     !!! Info "``ShockOsc/_Config/_All/Paused`` (bool)"
-        It's a kind of killswitch, pausing ShockOSC.  
+        It's a kind of kill switch, pausing ShockOSC.  
 
     !!! Info "``ShockOsc/_Config/_All/MinIntensity`` (Float)"
         Sets Minimum Intensity for the Random Mode.
@@ -80,21 +80,22 @@
 
     !!! Info "``ShockOsc/_Config/_All/MaxDuration`` (Float)"
         Sets Maximum Duration for the Random Mode.  
-    
+
     !!! Info "``ShockOsc/_Config/_All/Duration`` (Float)"
         Sets Duration Time for the Fixed Mode (100% = 10 Sec.) 
-    
+
     !!! Info "``ShockOsc/_Config/_All/Intensity`` (Float)"
         Sets Intensity for the Fixed Mode.
-    
+
     !!! Info "``ShockOsc/_Config/_All/ModeIntensity`` (Float)"
         Toggles between Fixed and Random Intensity Mode (True = Random)  
 
     !!! Info "``ShockOsc/_Config/_All/ModeDuration`` (Float)"
-        Toggles between Fixed and Random Duration Mode (True = Random)   
+        Toggles between Fixed and Random Duration Mode (True = Random)
 
     !!! Info "``ShockOsc/_Config/_All/CooldownTime`` (Float)"
         Sets the desired cooldown time.  (0 - 100 sec.)
 
     !!! Info "``ShockOsc/_Config/_All/HoldTime`` (Float)"
         Sets the time needed to hold the trigger to activate a shock.
+<!-- markdownlint-enable MD046 -->

docs/guides/shockosc-avatar-setup-vrc.md

@@ -2,7 +2,7 @@
 
 ## What you need
 
-- [ShockOsc](shockosc-basic.md)
+- [ShockOSC](shockosc-basic.md)
 - A VRChat avatar
 - Basic experience in working with VRChat avatars is recommended
 
@@ -27,11 +27,11 @@
     - **Collision Tags**: I recommend that you at least use the ``Finger`` Tag, otherwise people can't touch the trigger with their fingers, but is's up to you what kind of tags you use.
     - **Receiver Type**: this needs to be set to ``constant``.
     - **Parameter**: ``ShockOsc/{GroupName}``  
-      Replace *{GroupName}* with the name you gave your shocker in the [ShockOsc config](./shockosc-basic.md#setup-shockosc).  
+      Replace *{GroupName}* with the name you gave your shocker in the [ShockOSC config](./shockosc-basic.md#setup-shockosc).  
       Example: ``ShockOsc/leftleg``.  
     !!! example "Example"
         ![Image "Image"](../static/guides/shockosc/example_settings3.png)  
-        
+
 4. Upload your Avatar and you are ready to go! 🎉  
 
 !!! bug "Activate OSC"
@@ -51,7 +51,7 @@ This will utilize the Contact Sender and Receiver components of the VRChatSDK to
 2. Create a Receiver
     1. In the Hierarchy right click your Avatar
     2. Click *Create Empty* to create a new GameObject
-    3. Rename it to something like "ShockOsc Receiver".
+    3. Rename it to something like "ShockOSC Receiver".
     4. Select the newly created object and go into the inspector, click on *Add Component* and add a ``VRC Contact Receiver`` component to the object.
 3. Setup the Receiver
     1. Increase the Range of the component (max. 3m, that's a limit enforced by VRChat)
@@ -75,7 +75,7 @@ This will utilize the Contact Sender and Receiver components of the VRChatSDK to
 2. Create a Sender
     1. In the Hierarchy right click your Avatar
     2. Click *Create Empty* to create a new GameObject
-    3. Rename it to something like "ShockOsc Sender".
+    3. Rename it to something like "ShockOSC Sender".
     4. Select the newly created object and go into the inspector, click on *Add Component* and add a ``VRC Contact Sender`` component to the object.
 3. Setup the Sender
     1. Increase the Range of the component (max. 3m, that's a limit enforced by VRChat)
@@ -113,10 +113,10 @@ This will utilize the Contact Sender and Receiver components of the VRChatSDK to
 ## Pull trigger
 
 !!! info "Still brewing!"
-    Sorry, we haven't *quite* gotten around to writing this set of articles just yet. **In the meantime, feel free to hit us up on [Discord](https://discord.gg/AHcCbXbEcF).**
+    Sorry, we haven't *quite* gotten around to writing this set of articles just yet. **In the meantime, feel free to hit us up on [Discord](https://discord.gg/OpenShock).**
 
 ## List of available parameters
-
+<!-- markdownlint-disable MD046 -->
 === "Avatar Dynamic Parameters "
     !!! Info "``ShockOsc/{GroupName}`` (bool)"
         when set to ``true`` and held, will trigger a normal shock in ShockOSC
@@ -187,3 +187,4 @@ This will utilize the Contact Sender and Receiver components of the VRChatSDK to
 
     !!! Info "``ShockOsc/_Config/_All/HoldTime`` (Float)"
         Sets the time needed to hold the trigger to activate a shock.
+<!-- markdownlint-enable MD046 -->

docs/guides/shockosc-basic.md

@@ -1,21 +1,21 @@
 # Basic Setup
 
-!!! question "What is ShockOsc?"
-    ShockOsc is an application made for OSC to trigger your shockers from an in-game trigger.  
+!!! question "What is ShockOSC?"
+    ShockOSC is an application made for OSC to trigger your shockers from an in-game trigger.  
     [OSC](https://docs.vrchat.com/docs/osc-overview) is a service implemented in VRChat that allows the communication between the game and 3rd party applications.
 
-!!! info "New ShockOsc"
-    Information on this page is dedicated to the **new** version of ShockOsc, the old version is no longer supported.
+!!! info "New ShockOSC"
+    Information on this page is dedicated to the **new** version of ShockOSC, the old version is no longer supported.
 
 ## What you need
 
 - [Fully setup shocker](openshock-first-setup.md)
-- [Newest ShockOsc](https://github.com/OpenShock/ShockOsc/releases)
+- [Newest ShockOSC](https://github.com/OpenShock/ShockOSC/releases)
 - [Shocklink Account](https://shocklink.net/)
 
 ## Setup ShockOsc
 
-1. [Download ShockOSC](https://github.com/OpenShock/ShockOsc/releases) and install it.
+1. [Download ShockOSC](https://github.com/OpenShock/ShockOSC/releases) and install it.
 2. Login to ShockOSC
     1. Open ShockOSC
     2. Click on "Get Token", this will open a browser window.

docs/hardware/boards/dfr-firebeetle/dfr-firebeetle.md

@@ -8,7 +8,7 @@ tags:
     - support:community
 ---
 
-# DFRobot Firebeetle 2 ESP32-E
+# DFRobot FireBeetle 2 ESP32-E
 
 !!! success "Fully compatible"
     This product is fully compatible with OpenShock.
@@ -27,8 +27,8 @@ tags:
 
 ## Buying
 
-- <https://www.dfrobot.com/product-2195.html>
+- [www.dfrobot.com](https://www.dfrobot.com/product-2195.html)
 
 ## Media
 
-![DFRobot Firebeetle](../../../static/boards/dfrobot-firebeetle/firebeetle.jpg)
+![DFRobot FireBeetle](../../../static/boards/dfrobot-firebeetle/firebeetle.jpg)