Markdown formatting fixes bonanza

src/docs/debugging/contributing.md

@@ -1,14 +1,14 @@
 # Supporting the Docs
 Want to help support the docs? Well there's some ways you can help!
 
-### Contributing via Issues
+## Contributing via Issues
 
 Contributing via Issues is pretty simple but there are some rules:
 
 * Reserve the issues tab exclusively for documentation-related matters; refrain from discussing personal support issues or OS installation problems there.
 * When reporting a typo or suggesting better clarification, please specify the page where the issue is found. It would be helpful to avoid searching extensively for these problems.
 
-### Contributing via PRs
+## Contributing via PRs
 
 Some guidelines when contributing via PRs:
 
@@ -18,12 +18,11 @@ Some guidelines when contributing via PRs:
     * Additionally, it would be appreciated if you can provide sources for significant commits. This helps us verify the validity of the information you provide.
 * Ensure that the pages adhere to the markdown style used in the docs.
 
-### How to Contribute
+## How to Contribute
 
 The best way to test your commits and ensure proper formatting is by forking the repository, making and testing changes locally, then contributing with a pull request.
 
-
-**Simple step-by-step guide**
+### Simple step-by-step guide
 
 * Install NodeJS
   * You can download NodeJS from [the NodeJS download page](https://nodejs.org/en/download).
@@ -36,7 +35,7 @@ The best way to test your commits and ensure proper formatting is by forking the
 Vuepress will automatically regenerate pages when you make changes.
 :::
 
-### Tips
+## Tips
 
 Some tools that make contributing a bit easier:
 

src/docs/faq.md

@@ -14,7 +14,7 @@ Please read this page before asking a question in the Discord. Your help request
 * No. Only the Linux drivers are free.
 
 #### How come audio isn't working on Ubuntu / Ubuntu forks?
-* Ubuntu and Ubuntu-based distros may have issues, try swtiching to another distro.
+* Ubuntu and Ubuntu-based distros may have issues, try switching to another distro.
 
 #### What Linux distros are recommended?
 * See [this page](installing/installing-linux.md).
@@ -82,7 +82,7 @@ Please read this page before asking a question in the Discord. Your help request
   * Then exit developer mode by running `sudo crossystem disable_dev_request=1; reboot`
 
 #### Can I modify the fan speed?
-* Yes, using ectool. On windows this is installed along with the [`crosec` driver](https://github.com/coolstar/driverinstallers/raw/master/crosec/crosec.2.0.2-installer.exe) (will be located at `C:\Program Files\crosec\ectool.exe`), on linux you can grab it from [here](https://tree123.org/files/utils/ectool). To set the fan to auto, run: `ectool autofanctrl`. To specify a percentage, run `ectool fanduty [0-100]`.
+* Yes, using ectool. To set the fan to auto, run: `ectool autofanctrl`. To specify a percentage, run `ectool fanduty [0-100]`.
 
 #### Can I overclock the fan?
 * No.

src/docs/firmware/about.md

@@ -4,7 +4,7 @@ next: flashing-firmware
 ---
 # Types of Firmware
 
-### RW_LEGACY
+## RW_LEGACY
 
 * Updates/replaces the stock RW_LEGAGY payload (SeaBIOS or edk2) included on many older models; supplements the ChromeOS / secure boot payload (depthcharge)
 * Leaves all stock functionality intact, including the Developer Mode boot screen and Recovery Mode functionality
@@ -17,7 +17,7 @@ next: flashing-firmware
 Do not run Windows on RW_LEGACY. The RW_LEGACY firmware is for users who want to dual-boot ChromeOS + Linux, or users who want to run Linux without having to open the device/disable the firmware write-protect (and are OK with the accompanying limitations).
 :::
 
-### (UEFI) Full ROM
+## (UEFI) Full ROM
 * A complete firmware image which includes updated/customized versions of the hardware init component (coreboot) and UEFI boot payload (edk2)
 * Removes the developer mode boot ("OS verification is OFF") screen
 * Completely removes the ability to run ChromeOS (and ChromeOS Recovery Mode), creating a small risk of bricking your device

src/docs/firmware/battery.md

@@ -18,7 +18,7 @@ Screws may be underneath "feet", or the material that keeps the Chromebook from
 :::
 
 3. Gently pry the back off the Chromebook. If you do not have the proper tools a dull knife would be helpful.
-      - On some Chromebooks, the keyboard needs to be removed instead of the back. Be careful as there's a ribbon wire underneath that needs disconnecting first.
+    * On some Chromebooks, the keyboard needs to be removed instead of the back. Be careful as there's a ribbon wire underneath that needs disconnecting first.
 4. Unplug the battery connector. You do not need to take the entire battery out of the Chromebook.
 
 ## Step 2: Boot using AC power, and flash.
@@ -30,5 +30,5 @@ There is a 15V USB-C PD requirement for booting without the battery.
 :::
 
 2. Boot the chromebook up
-    - If you removed the keyboard, make sure to reattach it for this step.
+    * If you removed the keyboard, make sure to reattach it for this step.
 3. Continue to [Flashing Firmware](flashing-firmware.md)

src/docs/firmware/compiling-coreboot.md

@@ -7,9 +7,9 @@ Building and flashing your own firmware has the potential to brick your device.
 :::
 
 1. **Install tools and libraries needed for coreboot:**
-  * Debian based distros: `sudo apt install -y bison build-essential curl flex git gnat imagemagick libncurses5-dev m4 nasm python-is-python3 uuid-dev zlib1g-dev libssl-dev`
-  * Arch based distros: `sudo pacman --needed -S base-devel curl git gcc-ada ncurses zlib nasm imagemagick`
-  * Redhat based distros: `sudo dnf install git make gcc-gnat flex bison xz bzip2 gcc g++ ncurses-devel wget zlib-devel patch openssl libuuid-devel nasm texinfo`
+    * Debian based distros: `sudo apt install -y bison build-essential curl flex git gnat imagemagick libncurses5-dev m4 nasm python-is-python3 uuid-dev zlib1g-dev libssl-dev`
+    * Arch based distros: `sudo pacman --needed -S base-devel curl git gcc-ada ncurses zlib nasm imagemagick`
+    * Redhat based distros: `sudo dnf install git make gcc-gnat flex bison xz bzip2 gcc g++ ncurses-devel wget zlib-devel patch openssl libuuid-devel nasm texinfo`
 2. **Clone the repository:**
     * `git clone https://github.com/mrchromebox/coreboot.git`
 3. **`cd` to the coreboot folder, then build the coreboot toolchain**
@@ -21,6 +21,6 @@ Building and flashing your own firmware has the potential to brick your device.
 5. **Build the ROM**
     * create build dir: `mkdir -p ~/dev/firmware`
     * `./build-uefi.sh <boardname>`
-      * For example, `./build-uefi.sh careena`
-    * Roms will be stored in `~/dev/firmware`
+        * For example, `./build-uefi.sh careena`
+    * ROMs will be stored in `~/dev/firmware`
 6. **Continue onto [Flashing Manually](manually-flashing.md) to flash**

src/docs/firmware/developer-mode.md

@@ -4,7 +4,7 @@ next: write-protect
 ---
 # Enabling Developer Mode
 
-Enabling [developer mode](https://chromium.googlesource.com/chromiumos/docs/+/HEAD/developer_mode.md) is the first step to running an alternate OS on your chromebook!
+Enabling [developer mode](https://chromium.googlesource.com/chromiumos/docs/+/HEAD/developer_mode.md) is the first step to running an alternate OS on your chromebook! Developer Mode is an alternate mode that all chromeOS devices have that opens up the ability to make unverified changes to the operating system and hardware.
 
 ::: danger
 Doing this will wipe **all** user data! Make backups if needed before proceeding.
@@ -14,24 +14,22 @@ Doing this will wipe **all** user data! Make backups if needed before proceeding
 The battery must be plugged in while enabling developer mode.
 :::
 
-Developer Mode is an alternate mode that all chromeOS devices have that opens up the ability to make unverified changes to the operating system and hardware.
-
-1. Enter [recovery mode](recovery-mode.md).
+First, enter [recovery mode](recovery-mode.md).
 
 #### Chromebooks/Chromeboxes
 
-1. Press `CTRL` +  `D` at the same time. This should bring up a warning asking for confirmation for either "Turn OS Verification OFF" or "Enable Developer Mode".
+1. Press Ctrl+D. This should bring up a warning asking for confirmation for either "Turn OS Verification OFF" or "Enable Developer Mode".
 
-2. Press `Enter`. The system should reboot and bring you to the "You are in Developer Mode" or "OS Verification is OFF" screen.
+2. Press Enter. The system should reboot and bring you to the "You are in Developer Mode" or "OS Verification is OFF" screen.
 
-3. Press `CTRL` +  `D` to boot from internal disk.
+3. Press Ctrl+D to boot from internal disk.
 
 4. Setup the system like normal, but **do not enable debugging features**.
 
 #### Tablets
 
 1. Press `Volume Up` + `Volume Down` to bring up the menu selection screen.
 
-2. Use the `Volume Up` and `Volume Down` to navigate to  "Confirm Enabling Developer Mode", then press `Power` to select it. The system should reboot and bring you to the OS Verification is OFF" screen.
+2. Use the `Volume Up` and `Volume Down` to navigate to "Confirm Enabling Developer Mode", then press `Power` to select it. The system should reboot and bring you to the "OS Verification is OFF" screen.
 
 3. Select "Developer Options", then select "Boot from Internal Disk".

src/docs/firmware/flashing-firmware.md

@@ -30,14 +30,14 @@ Otherwise, shutdown without worry.
 If you unplugged the battery to [disable write protect](battery.md), you can plug it back in now. All subsequent flashing won't require it from now on.
 :::
 
-**UEFI**
+#### UEFI
 
 It can take up to a minute for display to come up on first POST. **Do not interrupt the first boot.**
 
-**RW_Legacy**
+#### RW_LEGACY
 
-On the developer mode boot screen, press `CTRL` + `L`. If a selection appears, pick "Tianocore".
+On the developer mode boot screen, press Ctrl+L. If a selection appears, pick "Tianocore".
 
-If you are met with a white `Alternative Firmware Menu` screen (after pressing `CTRL` + `L`), enter `2` to boot from USB or `0` to boot from internal storage (where you installed your Linux OS).
+If you are met with a white "Alternative Firmware Menu" screen (after pressing Ctrl+L), press 2 to boot from USB or `0 to boot from internal storage (where you installed your Linux OS).
 
-Further boot options can be accessed after you have entered a number, by pressing `ESC` as signified by the booting screen. If you wish to access these options before you've installed an OS, press `0` then `ESC`.
+Further boot options can be accessed after you have entered a number, by pressing ESC as signified by the booting screen. If you wish to access these options before you've installed an OS, press 0 then ESC.

src/docs/firmware/index.md

@@ -13,28 +13,28 @@ Do not continue if your device is currently owned or enrolled by a organization,
 :::
 
 ## Prerequisites
+
 * Know your hardware 
-  * Your CPU model and generation
-  * Your storage devices (HDD/SSD, eMMC, NVMe, etc.)
-  * **Your boardname**
-    * For example, the boardname for Asus Chromebook C302CA is `Cave`
-  * If you don't know where to find this info, take a look at the [System Info Page](system-info.md).
+    * Your CPU model and generation
+    * Your storage devices (HDD/SSD, eMMC, NVMe, etc.)
+    * **Your boardname**
+        * For example, the boardname for Asus Chromebook C302CA is `Cave`
+    * If you don't know where to find this info, take a look at the [System Info Page](system-info.md).
 * **A basic knowledge of command lines and how to use a terminal/command prompt.**
-  * We cannot help you if you do not know how to go to a directory or delete a file from a terminal.
+    * We cannot help you if you do not know how to go to a directory or delete a file from a terminal.
 * A minimum of an 8GB USB drive or SD Card for creating a bootable OS installer.
 * A second device is recommended, and required in some cases.
 
-::: tip
+::: tip NOTE
 Only x86_64 devices are currently supported.
 :::
 
 ::: tip
-If you only have one device. Please be sure to [setup a usb with your OS to install](ventoy.md) before flashing.
+If you only have one device, please be sure to [setup a usb with your OS to install](ventoy.md) before flashing.
 :::
 
-------
+## Asking for help properly
 
-### Asking for help properly:
 If you are facing a issue, please read the [FAQ](../faq.md) first.
 
 ::: tip

src/docs/firmware/known-issues.md

@@ -14,9 +14,8 @@ You should avoid buying any devices in this list.
 * Samsung Galaxy Chromebook (KOHAKU): Badly designed hardware, deteriorating trackpad grounding, possibly faulty backlight circuit.
 * Samsung Chromebox Series 3 (STUMPY): DisplayPort output is non-functional under Windows, and VGA output through the DVI port is non-functional.
 
----
-
 ## Firmware
+
 * **All ARM Chromebooks**: No support, though development is slowly starting.
 * GeminiLake: Legacy boot mode/alternative firmware menu works but does not show payload list
 * AMD Stoneyridge: Some Stoney Ridge devices may not currently have functional Legacy Boot Mode due to bugs in Google's firmware.

src/docs/firmware/recovery-mode.md

@@ -4,21 +4,21 @@ next: false
 ---
 # Recovery Mode
 
-::: tip
-Images sourced from [Google Support](https://support.google.com/chrome/a/answer/1360642?sjid=16957732159917599441-NC#chromebox&zippy=%2Cwipe-a-chromebox) and [Asus Support](https://www.asus.com/support/FAQ/1039185/).
-:::
+Recovery mode is used to restore the OS and RW regions of the firmware. It gets triggered when an issue with the device is detected, or you manually start it.
 
 ::: tip
 Your data is unaffected in recovery mode unless you use a recovery image or enter [developer mode](entering-developer-mode.html).
 :::
 
+::: tip NOTE
+Images sourced from [Google Support](https://support.google.com/chrome/a/answer/1360642?sjid=16957732159917599441-NC#chromebox&zippy=%2Cwipe-a-chromebox) and [Asus Support](https://www.asus.com/support/FAQ/1039185/).
+:::
+
 ::: danger
 Do not continue if your device is currently owned or enrolled by a organization, such as a school or employer. Unless you were given permission by your organization, its a crime.
 ::: 
 
-Recovery mode is used to restore the OS and RW regions of the firmware. It gets triggered when an issue with the device is detected, or you manually start it.
-### Entering Recovery Mode
-<br>
+## Entering Recovery Mode
 
 #### Chromebooks
 

src/docs/firmware/system-info.md

@@ -12,8 +12,9 @@ Some of the following commands require [Developer mode](developer-mode).
 
 Your system architecture is very important as it determines if your device has any support at all. ARM devices are not currently supported by the project, but support for them in the future is planned.
 
-#### How to find your architecture
-1. Open a crosh terminal by pressing `Control` + `Alt` + `T`
+### How to find your architecture
+
+1. Open a crosh terminal by pressing Ctrl+Alt+T
 2. Type `uname -m` and press enter
 
 You should now see one of three possible outputs:
@@ -23,38 +24,32 @@ You should now see one of three possible outputs:
 
 If you see `x86_64`, your device is very likely to be supported, you will need to find your board name next to see if your device is supported. If you see `armv7l`, `aarch64` or anything with `arm`, you have an ARM device which isn't currently supported.
 
----
-
 ## Board Name
 
 The board name is the special name for your device which determines if it is supported by the custom firmware.
 
 ### How to find your board name
 
 #### Developer Mode
-1. Open VT-2 (`ctrl` + `alt` + `f2` (right arrow)).
-2. Login as `chronos`.
-3. Type `sudo crossystem hwid` and press enter.
+1. Open VT-2 by pressing Ctrl + Alt + 🡢 (F2) and login as `chronos`
+2. Type `sudo crossystem hwid` and press Enter
 
 #### Recovery Mode
-1. Enter [Recovery Mode](recovery-mode.md).
-2. Find the "Model" line.
+1. Enter [Recovery Mode](recovery-mode.md)
+2. Find the "Model" line
 
 You should now see your board name and some extra characters.
 Example: `SNAPPY E25-A7C-J2L-I74-A47`
 In this example, `SNAPPY` is the board name and you can ignore the extra characters.
 
----
-
 ## CPU Model and generation
 
 The CPU model and generation is used to determine OS support and any extra steps you have to take after installing the OS.
 
 ### How to find your CPU model
 
-1. Open a crosh terminal by pressing `Control` + `Alt` + `T`
-2. Type `shell` and press enter
-3. Type `cat /proc/cpuinfo | grep "model name"` and press enter
+1. Open VT-2 by pressing Ctrl + Alt + 🡢 (F2) and login as `chronos`
+2. Type `cat /proc/cpuinfo | grep "model name"` and press Enter
 
 You should now see your CPU model repeated a few times, we only have to look at the first line.
 Example output: `model name      : Intel(R) Celeron(R) CPU N3350 @ 1.10GHz`
@@ -63,4 +58,4 @@ Example output: `model name      : Intel(R) Celeron(R) CPU N3350 @ 1.10GHz`
 
 1. Find your board name using the steps above (ex: `SNAPPY`).
 2. Go to the [Supported Devices Page](supported-devices.md).
-3. The Supported Devices Page has sections for each generation that has a list of boards for that specific generation. Use Ctrl + F to locate your board and find which generation it's listed under.
+3. The Supported Devices Page has sections for each generation that has a list of boards for that specific generation. Use Ctrl+F to locate your board and find which generation it's listed under.

src/docs/firmware/updating-firmware.md

@@ -1,7 +1,7 @@
 # Updating Custom Firmware
 
-::: tip
-These steps require linux. **Firmware Cannot be flashed from Windows**. Do not try to flash from a virtual machine such as wsl. If you are using Windows, boot a live linux iso, such as Ubuntu or Fedora Workstation.
+::: tip NOTE
+The script does not work on Windows. If you are using Windows, boot a live Linux iso, such as Ubuntu or Fedora, and run the script from there.
 :::
 
 ::: tip

src/docs/firmware/ventoy.md

@@ -1,18 +1,22 @@
 # Installing Ventoy to a USB drive with chromeOS
+
 Ventoy is a useful tool that allows you to have multiple OS installer images on a single drive. It is also the only way to properly create an installer for Windows using chromeOS.
 
 ## Backing up your drive
+
 Before we begin, be sure to backup any data that may be on your USB drive as it will be erased during this process.
 
 <img src="/ventoy/backup.png">
 
 ## Downloading Ventoy
+
 Grab the latest Ventoy release from [GitHub](https://github.com/ventoy/Ventoy/releases). Be sure to get the Linux version.
 
 <img src="/ventoy/download.png">
 
 ## Extracting Ventoy
-Open VT-2 by pressing `Ctrl` + `Alt` + `F2` (Right arrow/Refresh) and run the following commands as root:
+
+Open VT-2 by pressing Ctrl + Alt + 🡢 (F2) and run the following commands as root:
 
 1. `cd /usr/local`
 2. `tar xf /home/chronos/user/Downloads/ventoy-<ventoy version>-linux.tar.gz`
@@ -22,28 +26,31 @@ Open VT-2 by pressing `Ctrl` + `Alt` + `F2` (Right arrow/Refresh) and run the fo
 On commands 2 and 3, after typing `ventoy`, you can press tab to fill in the rest of the filename automatically.
 :::
 
-You can then run `ls` to verify you have the correct files, it should look something like this
+You can then run `ls` to verify you have the correct files, it should look something like this:
 
 <img src="/ventoy/extract.png">
 
 ## Starting Ventoy
+
 Run the following command to start the Ventoy Web GUI:
 * `./VentoyWeb.sh`
 
-Next, switch back to VT-1 by pressing `Ctrl` + `Alt` + `F1` (Left arrow) and open `http://localhost:24680` in Chrome.
+Next, switch back to VT-1 by pressing Ctrl + Alt + 🡠 (F1)and open `http://localhost:24680` in Chrome.
 
-You should see this on your screen now
+You should see this on your screen now:
 
 <img src="/ventoy/ventoy.png">
 
-## Installing Ventoy
+## Installing Ventoy to USB
+
 Plug in your USB drive and click the green circle to refresh devices. You should see your USB drive get detected. Now click options, then Partition Style, then choose GPT.
 
 <img src="/ventoy/gpt.png">
 
 Once you have done that and your drive is detected, click on Install and click Ok twice when prompted and again once the installation has completed. Once installation is complete, unplug and plug back in your USB drive.
 
 ## Adding OS images
+
 Download an image of any OS you want. For Windows we recommend that you only use official ISOs from Microsoft.
 
 Open Files and click on your USB drive, you should then see a device named "Ventoy".