Formatting and config tidying

README.md

@@ -2,21 +2,23 @@
 
 ## Getting Started
 
-First off, I recommend cloning this `docs` branch into a separate checkout entirely:
-
 ```bash
 git clone https://github.com/bellflight/AVR-Docs
 cd AVR-Docs
 npm install
+code
 ```
 
+I recommend installing the recommended VSCode extensions, and enabling
+`editor.formatOnSave` for the workspace.
+
 ## Tooling
 
-The generate the static site, we use the [Hugo](https://gohugo.io/)
-static site generator. The site is based on the [Docsy](https://docsy.dev)
-theme by Google. To install all the dependencies, you will need to have
-`nodejs` and `npm` installed. Check the [`.node-version`](.node-version) file
-to see what version of `node` is being used to build the site.
+The generate the static site, we use the [Hugo](https://gohugo.io/) static site
+generator. The site is based on the [Docsy](https://docsy.dev) theme by Google. To
+install all the dependencies, you will need to have `nodejs` and `npm` installed. Check
+the [`.node-version`](.node-version) file to see what version of `node` is being used to
+build the site.
 
 Running
 
@@ -32,17 +34,17 @@ To preview the site, run:
 npm run server
 ```
 
-This will automatically open your default web browser to a live-reloading
-version of the site running on your machine.
+This will automatically open your default web browser to a live-reloading version of the
+site running on your machine.
 
 ## Structure
 
-Every page in this site is it's own folder. This is to allow pages to be
-easily bundled with the images in the page.
+Every page in this site is it's own folder. This is to allow pages to be easily bundled
+with the images in the page.
 
-The content for each page is in the file `_index.md`. While `index.md` is _also_
-valid, the underscore version helps ensure that the file is at the top
-of the files when sorted alphabetically.
+The content for each page is in the file `_index.md`. While `index.md` is _also_ valid,
+the underscore version helps ensure that the file is at the top of the files when sorted
+alphabetically.
 
 Each page also should contain a frontmatter.
 
@@ -54,18 +56,18 @@ description: "Page description"
 ---
 ```
 
-While the folder name for the page is the URL slug, the `title` field in the
-frontmatter is how the page title actually appears. This should be wrapped
-in quotes to avoid any text escaping issues. The `weight` field is used to sort the
-pages. Otherwise, the pages will automatically be sorted alphabetically.
-A larger weight value will make the page sort lower. Finally, the `description`
-field is an optional field that will show a description of the page at the top,
-of the page, and below the page URL on its parent page.
+While the folder name for the page is the URL slug, the `title` field in the frontmatter
+is how the page title actually appears. This should be wrapped in quotes to avoid any
+text escaping issues. The `weight` field is used to sort the pages. Otherwise, the pages
+will automatically be sorted alphabetically. A larger weight value will make the page
+sort lower. Finally, the `description` field is an optional field that will show a
+description of the page at the top, of the page, and below the page URL on its parent
+page.
 
 ## Content
 
-The written content is just normal Markdown. I try to keep the line lengths below
-88 characters for split-screen readability.
+The written content is just normal Markdown. I try to keep the line lengths below 88
+characters for split-screen readability.
 
 There is some extra functionality provided by the theme, or that I like to use.
 
@@ -77,18 +79,18 @@ Links to external content are the same as normal Markdown.
 [10-Pack of Aluminum Standoffs (80mm)](https://www.amazon.com/uxcell-Aluminum-Standoff-Fastener-Quadcopter/dp/B01MSAHZQO/)
 ```
 
-However, links to internal content should use the `relref` shortcode. This has
-the added advantage of not needing to copy the full URL and automatic checks to
-make sure the link is valid.
+However, links to internal content should use the `relref` shortcode. This has the added
+advantage of not needing to copy the full URL and automatic checks to make sure the link
+is valid.
 
 ```markdown
 [building your AVR drone]({{< relref "../../primary-goal/avr-drone-assembly" >}})
 ```
 
 ### Keyboard Buttons
 
-With Markdown, you can still insert arbitrary HTML. My favorite usage of this
-is keyboard buttons, which is the `<kbd>` HTML tag. For example:
+With Markdown, you can still insert arbitrary HTML. My favorite usage of this is
+keyboard buttons, which is the `<kbd>` HTML tag. For example:
 
 > Press <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>Esc</kbd> to open Task Manager.
 
@@ -101,14 +103,12 @@ Press <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>Esc</kbd> to open Task Manager.
 To provide callouts, you can use the `alert` shortcode like so:
 
 ```markdown
-{{% alert title="Warning" color="warning" %}}
-The balance connector should always be used whenever the
-battery is being used with the charger.
-{{% /alert %}}
+{{% alert title="Warning" color="warning" %}} The balance connector should always be
+used whenever the battery is being used with the charger. {{% /alert %}}
 ```
 
-The `title` parameter is what the callout block will be called, and the `color`
-is the color of the color bar on the left side.
+The `title` parameter is what the callout block will be called, and the `color` is the
+color of the color bar on the left side.
 
 Here are the 4 types of callout blocks I like to use to stay consistent:
 
@@ -139,8 +139,8 @@ The `alt` text is optional, and can be omitted:
 
 ### YouTube Videos
 
-To embed a YouTube video in the page, you can use the `youtube` shortcode
-with the video ID like so:
+To embed a YouTube video in the page, you can use the `youtube` shortcode with the video
+ID like so:
 
 ```markdown
 {{< youtube 6s3Z06fJGpY >}}
@@ -153,49 +153,46 @@ shortcode.
 
 ```markdown
 {{< card header="**FlySky FS-i6S User Manual**" >}}
-FS-i6S-User-manual-20170706-compressed.pdf
-{{< /card >}}
+FS-i6S-User-manual-20170706-compressed.pdf {{< /card >}}
 ```
 
 The header can be omitted if desired.
 
 ### Static Files
 
-Please put static files like PDF manuals in the `static/files` folder and be sure
-to link to it with the `static` shortcode:
+Please put static files like PDF manuals in the `static/files` folder and be sure to
+link to it with the `static` shortcode:
 
 ```markdown
 {{< static "digital version here." "456_RDX-1_Pro_Manual_V14.pdf" >}}
 ```
 
-The first parameter is the text of the link,
-and the second parameter is the actual filename.
+The first parameter is the text of the link, and the second parameter is the actual
+filename.
 
 ### Banners
 
-Similar to the `alert` shortcode, you can use the `pageinfo` shortcode to create
-a banner across the page. The color options are the same as the `alert` shortcode.
+Similar to the `alert` shortcode, you can use the `pageinfo` shortcode to create a
+banner across the page. The color options are the same as the `alert` shortcode.
 
 ```markdown
-{{% pageinfo color="warning" %}}
-This is placeholder content.
-{{% /pageinfo %}}
+{{% pageinfo color="warning" %}} This is placeholder content. {{% /pageinfo %}}
 ```
 
 ### Spellcheck
 
-We use [cSpell](https://cspell.org/) to spell check the documentation. However,
-due to lots of brand names and Linux commands, it frequently thinks words are spelled
-wrong.
+We use [cSpell](https://cspell.org/) to spell check the documentation. However, due to
+lots of brand names and Linux commands, it frequently thinks words are spelled wrong.
 
 The best way to fix it, is to add the word to the [avr-wordlist.txt](avr-wordlist.txt)
-file. However, for larger sections of text that has issues
-(like command output or Youtube video IDs), place a "disable" and "enable" statement
-before and after like so:
+file. However, for larger sections of text that has issues (like command output or
+Youtube video IDs), place a "disable" and "enable" statement before and after like so:
 
 ```markdown
 <!-- cSpell:disable -->
+
 {{< youtube c-8FmdxJJd4 >}}
+
 <!-- cSpell:enable -->
 ```
 

content/en/3d-printing/_index.md

@@ -4,8 +4,8 @@ weight: 2
 description: "This section shows the the required 3D prints for this year's drone"
 ---
 
-For AVR, you'll need to 3D print some parts for your drone.
-While not needed immediately, these are good to get started with:
+For AVR, you'll need to 3D print some parts for your drone. While not needed
+immediately, these are good to get started with:
 
 Explore each of the subsections to see what you'll need to print.
 
@@ -19,7 +19,6 @@ Change the units from Meters to Millimeters.
 
 ![Onshape Units Selection](3d_download_default.png)
 
-The export page should resemble the following.
-Press OK.
+The export page should resemble the following. Press OK.
 
 ![Onshape Export Page](3d_download_mm.png)

content/en/3d-printing/gimbal/_index.md

@@ -5,13 +5,19 @@ description: "3D prints for the thermal camera gimbal"
 ---
 
 - AVR-GIMBAL-BASE (x1)
-  - STL file: [AVR-GIMBAL-BASE.stl](https://cad.onshape.com/documents/e60caeb54c300b56c38a9f61)
-  - STEP file: [AVR-GIMBAL-BASE.stp](https://cad.onshape.com/documents/806c78ce35e269c5b1ad89dc)
+  - STL file:
+    [AVR-GIMBAL-BASE.stl](https://cad.onshape.com/documents/e60caeb54c300b56c38a9f61)
+  - STEP file:
+    [AVR-GIMBAL-BASE.stp](https://cad.onshape.com/documents/806c78ce35e269c5b1ad89dc)
 - AVR-GIMBAL-PAN (x1)
-  - STL file: [AVR-GIMBAL-PAN.stl](https://cad.onshape.com/documents/f88c62c67a1ab5c2f6cfc7c4/w/d59659e7f3c445a8f985d0a4/e/ebaf94a7dace575bfa791130)
-  - STEP file: [AVR-GIMBAL-PAN.stp](https://cad.onshape.com/documents/05f08129518797caf024158f/w/80ba07e5604aa6c86bd831df/e/f75861e8d9d2f3c8d5cf00be)
+  - STL file:
+    [AVR-GIMBAL-PAN.stl](https://cad.onshape.com/documents/f88c62c67a1ab5c2f6cfc7c4/w/d59659e7f3c445a8f985d0a4/e/ebaf94a7dace575bfa791130)
+  - STEP file:
+    [AVR-GIMBAL-PAN.stp](https://cad.onshape.com/documents/05f08129518797caf024158f/w/80ba07e5604aa6c86bd831df/e/f75861e8d9d2f3c8d5cf00be)
 - AVR-GIMBAL-TILT (x1)
-  - STL file: [AVR-GIMBAL-TILT.stl](https://cad.onshape.com/documents/378111724c9b2c2066f4343c)
-  - STEP file: [AVR-GIMBAL-TILT.stp](https://cad.onshape.com/documents/add04c066036cdd648ea66c9)
+  - STL file:
+    [AVR-GIMBAL-TILT.stl](https://cad.onshape.com/documents/378111724c9b2c2066f4343c)
+  - STEP file:
+    [AVR-GIMBAL-TILT.stp](https://cad.onshape.com/documents/add04c066036cdd648ea66c9)
 
 An infill of 15% should be sufficient for these parts.

content/en/3d-printing/landing-gear/_index.md

@@ -5,16 +5,21 @@ description: "3D prints for the landing gear"
 ---
 
 - AVR-LANDING-GEAR-MOUNT (x4)
-  - STL file: [AVR-LANDING-GEAR-MOUNT.stl](https://cad.onshape.com/documents/3111e54b1b04514aeae7a864/w/143325ef8d6ebdd537b470ee/e/b22e3b7065b1cd4f7302c1af?renderMode=0&uiState=6306944891cbbe0c90ef6159)
-  - STEP file: [AVR-LANDING-GEAR-MOUNT.stp](https://cad.onshape.com/documents/fa003edf875e5b2872904249/w/19f57e1552f34fc165774c35/e/ad10644669e5451a597cee1b)
+  - STL file:
+    [AVR-LANDING-GEAR-MOUNT.stl](https://cad.onshape.com/documents/3111e54b1b04514aeae7a864/w/143325ef8d6ebdd537b470ee/e/b22e3b7065b1cd4f7302c1af?renderMode=0&uiState=6306944891cbbe0c90ef6159)
+  - STEP file:
+    [AVR-LANDING-GEAR-MOUNT.stp](https://cad.onshape.com/documents/fa003edf875e5b2872904249/w/19f57e1552f34fc165774c35/e/ad10644669e5451a597cee1b)
 - AVR-LANDING-GEAR-BRACE (x4)
-  - STL file: [AVR-LANDING-GEAR-BRACE.stl](https://cad.onshape.com/documents/485005cf8f758e5c698effb5/w/bd4c6d9668037e376ceb49f9/e/550aecfaa6c26cb1a344f6df)
-  - STEP file: [AVR-LANDING-GEAR-BRACE.stp](https://cad.onshape.com/documents/129bfa2356bc354a6be7862a)
+  - STL file:
+    [AVR-LANDING-GEAR-BRACE.stl](https://cad.onshape.com/documents/485005cf8f758e5c698effb5/w/bd4c6d9668037e376ceb49f9/e/550aecfaa6c26cb1a344f6df)
+  - STEP file:
+    [AVR-LANDING-GEAR-BRACE.stp](https://cad.onshape.com/documents/129bfa2356bc354a6be7862a)
 - AVR-LANDING-GEAR-FOOT (x4)
-  - STL file: [AVR-LANDING-GEAR-FOOT.stl](https://cad.onshape.com/documents/76aba847b994f374e2738b88)
-  - STEP file: [AVR-LANDING-GEAR-FOOT.stp](https://cad.onshape.com/documents/4e2a1a3e0036de025ce1eee8)
+  - STL file:
+    [AVR-LANDING-GEAR-FOOT.stl](https://cad.onshape.com/documents/76aba847b994f374e2738b88)
+  - STEP file:
+    [AVR-LANDING-GEAR-FOOT.stp](https://cad.onshape.com/documents/4e2a1a3e0036de025ce1eee8)
 
-{{% alert title="Note" color="note" %}}
-For the landing gear it is highly advised that you print with 100% infill as these are
-going to be parts that will need to with stand the impact of landing.
-{{% /alert %}}
+{{% alert title="Note" color="note" %}} For the landing gear it is highly advised that
+you print with 100% infill as these are going to be parts that will need to with stand
+the impact of landing. {{% /alert %}}

content/en/3d-printing/mounts/_index.md

@@ -5,11 +5,15 @@ description: "3D prints for mounting the ZED Mini camera"
 ---
 
 - AVR-CAM-ZED-MINI-MOUNT (x1)
-  - STL file: [AVR-CAM-ZED-MINI-MOUNT.stl](https://cad.onshape.com/documents/275a94e0083da92079e53590/w/e0e9c910fe8fe3d17c846072/e/a02e64b6117d28952632b5bb)
-  - STEP file: [AVR-CAM-ZED-MINI-MOUNT.stp](https://cad.onshape.com/documents/583faa803348f8994e357cc1)
+  - STL file:
+    [AVR-CAM-ZED-MINI-MOUNT.stl](https://cad.onshape.com/documents/275a94e0083da92079e53590/w/e0e9c910fe8fe3d17c846072/e/a02e64b6117d28952632b5bb)
+  - STEP file:
+    [AVR-CAM-ZED-MINI-MOUNT.stp](https://cad.onshape.com/documents/583faa803348f8994e357cc1)
 - AVR-BATTERY-STANDOFF-SMC (X1)
-  - STL file: [AVR-BATTERY-STANDOFF-SMC.stl](https://cad.onshape.com/documents/05fa168a306fc9b02dcde363)
-  - STEP file: [AVR-BATTERY-STANDOFF-SMC.stp](https://cad.onshape.com/documents/7e88ec918372d236e4c1704a)
+  - STL file:
+    [AVR-BATTERY-STANDOFF-SMC.stl](https://cad.onshape.com/documents/05fa168a306fc9b02dcde363)
+  - STEP file:
+    [AVR-BATTERY-STANDOFF-SMC.stp](https://cad.onshape.com/documents/7e88ec918372d236e4c1704a)
 
 An infill of 15% should be sufficient for these parts.
 

content/en/3d-printing/tello/_index.md

@@ -5,8 +5,10 @@ description: "3D prints for the Tello drone"
 ---
 
 - AVR-TELLO-CAGE-BRACKET (x1)
-  - STL file: [AVR-TELLO-CAGE-BRACKET.stl](https://cad.onshape.com/documents/48983f6b36ff3822e8dc8726/w/2a2bc308590d3bfe38b56c55/e/80e492c7ebf9fb31af4a6b3e)
+  - STL file:
+    [AVR-TELLO-CAGE-BRACKET.stl](https://cad.onshape.com/documents/48983f6b36ff3822e8dc8726/w/2a2bc308590d3bfe38b56c55/e/80e492c7ebf9fb31af4a6b3e)
 
-This bracket goes on the front of the Tello to prevent it from getting stuck in the AVR net.
+This bracket goes on the front of the Tello to prevent it from getting stuck in the AVR
+net.
 
 ![Tello Cage Bracket](avr_tello_cage_print.jpg)

content/en/_index.md

@@ -9,21 +9,19 @@ cascade:
 
 ## Introduction
 
-Welcome to the documentation for the Bell Advanced Vertical Robotics competition!
-Be sure to pay attention to the navigation links on the left and please keep in mind
-that this documentation is a **living document** that will be constantly updated over time.
-There will be new sections added, typos fixed, and bugs squashed throughout
-this process.
+Welcome to the documentation for the Bell Advanced Vertical Robotics competition! Be
+sure to pay attention to the navigation links on the left and please keep in mind that
+this documentation is a **living document** that will be constantly updated over time.
+There will be new sections added, typos fixed, and bugs squashed throughout this
+process.
 
-{{% alert title="Warning" color="warning" %}}
-It is **incredibly important** to follow the steps outlined in this documentation in
-order. The navigation on the left provides a sequential ordering of steps.
-{{% /alert %}}
+{{% alert title="Warning" color="warning" %}} It is **incredibly important** to follow
+the steps outlined in this documentation in order. The navigation on the left provides a
+sequential ordering of steps. {{% /alert %}}
 
 ## Requirements
 
-To be able to successfully compete in AVR, you must have the following
-available to you:
+To be able to successfully compete in AVR, you must have the following available to you:
 
 - A 3D printer (8.5" cubed) with 1 roll of ABS filament
 - A laptop with one of the following:

content/en/advanced-drone-assembly/_index.md

@@ -3,9 +3,9 @@ title: "Advanced Drone Assembly"
 weight: 11
 ---
 
-Please make sure you've successfully **built** and **flown** your basic AVR drone.
-You will be making some extensive modifications to your drone in
-preparation for advanced assembly.
+Please make sure you've successfully **built** and **flown** your basic AVR drone. You
+will be making some extensive modifications to your drone in preparation for advanced
+assembly.
 
 ![AVR advanced drone assembly (front)](avr_advanced_drone_front.jpg)
 

content/en/advanced-drone-assembly/assembly-review/_index.md

@@ -3,7 +3,7 @@ title: "Assembly Review"
 weight: 6
 ---
 
-**Great job!** Please take a few minutes to watch the video below and
-review all that we covered during the advanced hardware modifications.
+**Great job!** Please take a few minutes to watch the video below and review all that we
+covered during the advanced hardware modifications.
 
 {{< youtube _11tVfCxToM >}}