Edit markdown formatting and page layout for consistency, clean up tr…

…ailing spaces and unnecessary blank lines in code to address chrultrabook#87 Replace some horizontal lines with breaks for a better reading experience Fix non-sequential numbering Make title block on each page more uniform with consideration to adding relevant terminology for that page directly underneath the title (see open WIP checklist chrultrabook#62) Move install directions for Chrultrabook Controller to post-install.md Remove old information regarding running Windows on RW_LEGACY if using Ryzen Remove accidental "reboot" instruction on purchasing-drivers.md ...and other various minor fixes
sadlerm4 · Nov 10, 2023 · b6e26df · b6e26df
1 parent 0c825ee
commit b6e26df
Show file tree

Hide file tree

Showing 25 changed files with 317 additions and 410 deletions.
diff --git a/docs/allaboutfirmware.md b/docs/allaboutfirmware.md
@@ -5,7 +5,7 @@ nav_order: 8
 ---
 
 
-## All About Firmware
+# All About Firmware
 
 ### Terminology 
 
@@ -15,28 +15,26 @@ nav_order: 8
 | UEFI         | The Unified Extensible Firmware Interface (UEFI) is a specification that defines a software interface between an operating system and platform firmware. UEFI replaces the legacy Basic Input/Output System (BIOS) firmware interface originally present in all IBM PC-compatible personal computers, with most UEFI firmware implementations providing support for legacy BIOS services. UEFI can support remote diagnostics and repair of computers, even with no operating system installed. (source: Wikipedia) |  
 | EC           | Embedded Controller. Communicates between the main board and embedded peripherals such as hotkeys, ports, or battery.  
 
+---
 
-### Firmware Types
+## Firmware Types
 
-----------------------
+### RW_LEGACY
+
+{: .warning }
+Touchscreen and microphones that rely on the AVS driver **WILL NOT** work on 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
 * Allows device to dual-boot another OS alongside ChromeOS
 * Does not require disabling the firmware write-protect
 * Carries zero risk of bricking the device
 * On many models, includes bugfixes and enables additional functionality
-* Required to boot windows on Zen2 devices (Ryzen 3000)
-
-{: .warning }
-Touchscreen and microphones that rely on the AVS driver **WILL NOT** work on RW_LEGACY!
 
-{: .highlight }
-Do not run Windows on RW_LEGACY unless you have a AMD Ryzen device. 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). Or for Ryzen users that require booting from stock firmware for Windows to function properly.
+{: .note }
+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
@@ -52,8 +50,6 @@ The (UEFI) Full ROM firmware is the best option for all users who no longer need
 
 <br>
 
---------------
-
 <table>
   <tr>
     <td class="navtable-l">

diff --git a/docs/altos.md b/docs/altos.md
@@ -4,12 +4,11 @@ layout: default
 nav_order: 10
 ---
 
-## altOS Pros / Cons
-
------------------------
+# altOS Pros / Cons
 
+---
 
-**Windows:**
+## Windows
 
 Pros:
 * Works on most platforms with minimal tweaking¹
@@ -26,11 +25,11 @@ Cons:
 
 <br>
 
-¹Some devices such as CELES need workarounds. Additionally, AMD Ryzen devices need to use CoolStar's RW_LEGACY script in order to boot Windows. Refer to the [known issues page](known-issues.html) to check whether you need patches.
+¹Some devices such as CELES need workarounds. Refer to the [known issues page](known-issues.html) to check whether you need patches.
 
-----------
+---
 
-**Linux**
+## Linux
 
 Pros:
 * Free audio support 
@@ -49,10 +48,9 @@ Cons:
 
 ### [Installing Linux →](installing-linux.html)
 
+---
 
-----------
-
-**macOS**
+## macOS
 
 Pros:
 * OS experience is near identical to a Mac
@@ -72,7 +70,6 @@ Any Chromebook with a ARM, Celeron or Pentium CPU is not supported. AMD Ryzen mi
 
 <br>
 
-
 <table>
 <tr>
 <td class="navtable">

diff --git a/docs/bootableusb.md b/docs/bootableusb.md
@@ -4,23 +4,24 @@ layout: default
 nav_order: 27
 ---
 
-## Making a Bootable USB
+# Making a Bootable USB
 
+<br>
 {: .warning }
 Flashing Ventoy or ISO's to an external drive will **wipe all data** on said drive. Back up anything if you have to.
+<br>
 
-### Prerequisites
+## Prerequisites
 1. Another PC or laptop with at least 8GB storage
 2. A internet connection
-3. A external drive like a USB drive or SD card thats at least 8 gigabytes.
+3. A external drive like a USB drive or SD card thats at least 8GB.
 
-### Downloading a ISO
+## Downloading a ISO
 1. Determine what OS you want.
    - For Linux, keep in mind Ubuntu and any derivatives not based on 23.10 or higher **may have issues**.
    - For Windows, keep in mind only Windows 10 and newer are supported.
 2. Place the ISO in a safe place.
 
-
 ### Flashing using Rufus (Windows)
 
 For this guide, we will be using Rufus to create our bootable USB. 

diff --git a/docs/bugreport.md b/docs/bugreport.md
@@ -4,7 +4,7 @@ layout: default
 nav_order: 28
 ---
 
-## Bug Reporting
+# Bug Reporting
 
 So you find a bug in one of our projects, and want to report it. It's faily simple,
 
@@ -15,7 +15,6 @@ So you find a bug in one of our projects, and want to report it. It's faily simp
 4. Wait patiently for a contributor to fix the issue.
   - Please keep in mind the majority of us contributors have other things going on in our lives.
 <br>
-{: .note }
 
+{: .note }
 Do not submit personal help requests in the bugtracker. 
-
diff --git a/docs/compiling-coreboot.md b/docs/compiling-coreboot.md
@@ -5,9 +5,10 @@ nav_order: 20
 parent: Advanced
 ---
 
-### Cloning & Building ROMs
+# Compiling Custom Firmware
+<!-- insert one line description here -->
 
-<br>
+## Cloning & Building ROMs
 
 {: .warning }
 Building and flashing your own firmware has the potential to brick your device. Do not do this unless you are sure you know what you're doing/have a way to recover from a bad flash. Some level of knowledge with using the Linux command line is required.

diff --git a/docs/contributing.md b/docs/contributing.md
@@ -4,22 +4,21 @@ layout: default
 nav_order: 24
 ---
 
-## Supporting the Docs
-
+# Supporting the Docs
 Want to help support the docs? Well there's some ways you can help!
 
-------------
+<br>
 
-### 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:
 
@@ -29,14 +28,13 @@ 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 Ruby, Jekyll, and bundle
   * See [Jekyll's installation guide](https://jekyllrb.com/docs/installation/#guides) for your platform.
@@ -48,10 +46,6 @@ The best way to test your commits and ensure proper formatting is by forking the
 {: .note }
 Jekyll will automatically regenerate pages when you make changes.
 
-
-------------
-
-
 ### Tips
 
 Some tools that make contributing a bit easier:
@@ -60,6 +54,3 @@ Some tools that make contributing a bit easier:
 * [Typora](https://typora.io) for real time markdown rendering.
 * [TextMate](https://macromates.com) for easy and powerful mass find/replace.
 * [GitHub Desktop](https://desktop.github.com) for more user friendly GUI.
-
-
-------------
diff --git a/docs/csdriver.md b/docs/csdriver.md
@@ -7,37 +7,37 @@ nav_order: 14
 {: .warning }
 If your device is older than Skylake (6th gen), you do **not need to buy any drivers as they are free.** 
 
+# Purchasing CoolStar Drivers
 
-
-## Purchasing CoolStar Drivers
+<br>
 
 ### Step 1:
 
 Go to [CoolStar's Driver Portal](https://coolstar.org/chromebook/driverlicense/login.html) and click "Sign Up with Patreon".
 <img src="https://raw.githubusercontent.com/chrultrabook/docs/main/assets/csdriver/step1.png">
 
---------
+---
 
 ### Step 2:
 
 Click "Sign Up with Patreon" one more time.
 <img src="https://raw.githubusercontent.com/chrultrabook/docs/main/assets/csdriver/step2.png">
 
---------
+---
 
 ### Step 3:
 
 Sign in to Patreon. If you don't have an account, click "Sign Up" at the bottom of the screen and follow the on screen instructions. 
 <img src="https://raw.githubusercontent.com/chrultrabook/docs/main/assets/csdriver/step3.png">
 
---------
+---
 
 ### Step 4:
 
 After signing in, you should have been redirected to the screen below. Follow the prompts and click "Submit" when you are done.
 <img src="https://raw.githubusercontent.com/chrultrabook/docs/main/assets/csdriver/step4.png">
 
---------
+---
 
 ### Step 5:
 
@@ -136,7 +136,6 @@ Visit [CoolStar's Patreon](https://www.patreon.com/coolstar), sign in, then sele
 </details>
 <br>
 
-
 <img src="https://raw.githubusercontent.com/chrultrabook/docs/main/assets/csdriver/step5.png">
 
 {: .important }
@@ -148,14 +147,14 @@ You may need to select "See all 5 levels" if you don't see the driver you want.
 {: .note }
 To purchase more than one driver, you can change the "Choose what you pay" field at checkout.
 
---------
+---
 
 ### Step 6:
 
 Enter your payment information. You can also pay via PayPal.
 <img src="https://raw.githubusercontent.com/chrultrabook/docs/main/assets/csdriver/step6.png">
 
---------
+---
 
 ### Step 7:
 
@@ -165,13 +164,13 @@ Go back to the [CoolStar driver portal](https://coolstar.org/chromebook/driverli
 {: .note }
 It may take up to  two  (2) hours for the funds to show up. Do not panic, you  did not get scammed. 
 
---------
+---
 
 ### Step 8:
 Once the funds show up, head back to "Available Drivers", select the driver you want to buy, then click "Buy".
 <img src="https://raw.githubusercontent.com/chrultrabook/docs/main/assets/csdriver/step9.png">
 
---------
+---
 
 ### Step 9:
 
@@ -181,14 +180,7 @@ Once the funds show up, head back to "Available Drivers", select the driver you
 {: .warning }
 If you do not unsubscribe from the Patreon, you will get charged again next month.
 
---------
-
-### Step 10:
-Reboot.
-
-![image](https://github.com/chrultrabook/docs/assets/77316348/7202cae6-ac59-493b-b488-880ff313dd8b)
-
---------
+---
 
 <table>
 <tr>