Spelling fixes and improved wording & legibility (#67)

* Update index.md Spelling * Update index.md More spelling fixes * Update index.md Nonsensical capitalization * Update assembling.md Nonsensical capitalization + 'whether' makes it clearer + changed your to you (XDDDDD) * Update compile.md Changed , to ; + added a comma after 'First' * Update shockosc.md Changed 'Then switch avatar again.' to 'Then reload your avatar again.' I do not know if this is correct, please act accordingly. Also changed 'id' to 'ID' (id means something else) * Update bosjesman.md Changed 'give' to 'provide' (makes more sense in the context) Added a 'the' before 'quality' * Update luc.md Same as for BosjesMan * Update nullstalgia.md Same as Luc & Bosjesman * Update index.md Updated the disclaimer to the corrected version used for vendor pages * Update docs/diy/compile.md Removed very and added punctuation Co-authored-by: LostQuasar <[email protected]> --------- Co-authored-by: LostQuasar <[email protected]>
OpenShock · Jul 2, 2024 · 011e979 · 011e979
1 parent 0976d25
commit 011e979
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 12 deletions.
diff --git a/docs/diy/assembling.md b/docs/diy/assembling.md
@@ -6,12 +6,12 @@ This guide mainly focuses on the parts listed in the [Hardware Buy guide](../qui
 + ESP-32
 + 433 MHz transmitter
 + Soldering station
-+ Hookup wire (Optional depending if the pins line up)
++ Hookup wire (optional, depending on whether the pins line up)
 
 ## What/Where to buy?
 
 See the [Hardware Buy guide here](../quickstart/buying-guide.md). For the board/ESP-32 assembly you need the ESP-32 and a 433 MHz transmitter.
 
 ## Figuring out the PINs
 
-Any digital output pin on your micro-controller should work for outputting the signal for the transmitter, however the default is often close to the positive and ground pins on the controller. See the [boards](../hardware/boards/index.md) section dedicated to the micro-controller your are using to decide which pin to use.
+Any digital output pin on your micro-controller should work for outputting the signal for the transmitter, however the default is often close to the positive and ground pins on the controller. See the [boards](../hardware/boards/index.md) section dedicated to the micro-controller you are using to decide which pin to use.
diff --git a/docs/diy/compile.md b/docs/diy/compile.md
@@ -1,7 +1,7 @@
 # Compiling from source
 
 !!! info "Still brewing!"
-    This article heavily under development, expect very frequent changes
+    This article heavily under development; expect frequent changes.
 
 ## Requirements  
 
@@ -13,4 +13,4 @@ Open the folder you just downloaded  with VSCode. Allow time for PlatformIO to i
 
 ![An image showing where to find the icon for 'Pick project environment'](../static/diy/software/compiling/platformio.png)
 
-First run the `Device > Upload` task, then run `Platform > Upload Filesystem Image`. These tasks auto-build the latest changes and then upload the code to a connected micro-controller. This may require pressing the reset button on your micro-controller, refer to the documentation for your specific board for more information.
+First, run the `Device > Upload` task, then run `Platform > Upload Filesystem Image`. These tasks auto-build the latest changes and then upload the code to a connected micro-controller. This may require pressing the reset button on your micro-controller, refer to the documentation for your specific board for more information.
diff --git a/docs/index.md b/docs/index.md
@@ -9,7 +9,7 @@ Head over to the Guides to get started:
 
 - [What you need](quickstart/what-you-need.md)
 - [Buying guide](quickstart/buying-guide.md)
-- [How To Flash the Firmware](guides/openshock-how-to-flash-your-board.md)
+- [How to Flash the Firmware](guides/openshock-how-to-flash-your-board.md)
 - [Setup ESP and Shocker](guides/openshock-first-setup.md)
 
 ## Community

diff --git a/docs/troubleshooting/shockosc.md b/docs/troubleshooting/shockosc.md
@@ -21,9 +21,9 @@ Go ahead and click reset config in the VRChat action menu. This should reload yo
 or
 
 If it doesn't, navigate to `%userprofile%\appdata\locallow\VRChat\VRChat` and delete `OSC` folder.
-Then switch avatar again.
+Then reload your avatar again.
 
 ## Check config
 
-Make sure you have the correct name for the shocker set. Also double check you have set the correct id.
-You can get the shocker id from clicking edit on a shocker and copying the shown id.
+Make sure you have the correct name for the shocker set. Also double check you have set the correct ID.
+You can get the shocker ID from clicking edit on a shocker and copying the shown ID.
diff --git a/docs/vendors/hardware/bosjesman.md b/docs/vendors/hardware/bosjesman.md
@@ -5,7 +5,7 @@ tags:
 ---
 
 !!! warning "Disclaimer"
-    The OpenShock team does not give **any** guarantees about quality of products or services rendered.
+    The OpenShock team does not provide **any** guarantees about the quality of products or services rendered.
 
 # BosjesMan
 

diff --git a/docs/vendors/hardware/index.md b/docs/vendors/hardware/index.md
@@ -10,7 +10,7 @@ tags:
 This is a **non-curated list** of self-reported vendors from the OpenShock **community**.
 
 !!! warning "Disclaimer"
-    The OpenShock team does not give **any** guarantees about quality of products or services rendered.
+    The OpenShock team does not provide **any** guarantees about the quality of products or services rendered.
 
 ## Explanation
 

diff --git a/docs/vendors/hardware/luc.md b/docs/vendors/hardware/luc.md
@@ -5,7 +5,7 @@ tags:
 ---
 
 !!! warning "Disclaimer"
-    The OpenShock team does not give **any** guarantees about quality of products or services rendered.
+    The OpenShock team does not provide **any** guarantees about the quality of products or services rendered.
 
 # Luc
 

diff --git a/docs/vendors/hardware/nullstalgia.md b/docs/vendors/hardware/nullstalgia.md
@@ -5,7 +5,7 @@ tags:
 ---
 
 !!! warning "Disclaimer"
-    The OpenShock team does not give **any** guarantees about quality of products or services rendered.
+    The OpenShock team does not provide **any** guarantees about the quality of products or services rendered.
 
 # nullstalgia