From ac5bd3ec0b9b67be41c5d789893a886335ae612a Mon Sep 17 00:00:00 2001
From: ading2210 <ading2019@gmail.com>
Date: Fri, 7 Jun 2024 17:19:59 -0700
Subject: [PATCH] update documentation and issue templates

---
 .github/ISSUE_TEMPLATE/bug_report.md          | 13 +++++++++++-
 .../device-compatibility-report.md            | 10 +++++-----
 README.md                                     | 20 +++++++++----------
 3 files changed, 27 insertions(+), 16 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 93f8a30..39fc74a 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -7,6 +7,15 @@ assignees: ''
 
 ---
 
+<!--
+Before making a bug report please check that:
+- The USB drive/SD card you are using isn't faulty
+  - Dirt cheap USB 2.0 drives or fake high capacity ones will not work
+  - Generally if your drive is unbranded it is slow and of poor quality
+- The disk image you are using is not corrupted
+- You have *some* knowledge on how to use Linux
+-->
+
 **Describe the bug**
 A clear and concise description of what the bug is.
 
@@ -27,9 +36,11 @@ If you are reporting an issue with the build process, please run the scripts in
 
 **Target Chrome OS Device (please complete the following information):**
  - Board Name (e.g. dedede)
- - Device Name (e.g. drawcia)
+ - Device Name (e.g. drawcia) <!-- this page has a list of them: https://chromiumdash.appspot.com/serving-builds -->
  - Shimboot version (e.g. v1.0.1) 
 
+<!-- If you are using a prebuilt image please make note of that and delete this section. -->
+<!-- This section is for the device you build shimboot on, not your chromebook. -->
 **Build Device (please complete the following information):**
  - OS: [e.g. Debian 12]
  - Neofetch out [run `neofetch --stdout` and paste it here]
diff --git a/.github/ISSUE_TEMPLATE/device-compatibility-report.md b/.github/ISSUE_TEMPLATE/device-compatibility-report.md
index 8fbc5ca..301ae9e 100644
--- a/.github/ISSUE_TEMPLATE/device-compatibility-report.md
+++ b/.github/ISSUE_TEMPLATE/device-compatibility-report.md
@@ -11,12 +11,12 @@ This template is not meant to be used if Shimboot fails completely. Submit a bug
 
 **Compatibility Info**:
 - Board Name: (e.g. octopus)
-- X11: yes/no/untested
-- Wifi: yes/no/untested
-- Internal Audio: yes/no/untested
-- Backlight: yes/no/untested
+- X11: yes/no/untested  <!-- X11 is what handles your system's GUI. If a desktop showed up at all then X11 worked. -->
+- Wifi: yes/no/untested 
+- Internal Audio: yes/no/untested <!-- This is referring to your laptop speakers. -->
+- Backlight: yes/no/untested  <!-- This means whether or not you can control your screen brightness. -->
 - Touchscreen: yes/no/untested
-- 3D acceleration: yes/no/untested
+- 3D acceleration: yes/no/untested <!-- Does `glxinfo | grep "renderer string"` report the correct GPU name? -->
 - Bluetooth: yes/no/untested
 - Webcam: yes/no/untested
 
diff --git a/README.md b/README.md
index f8ca122..bc42840 100644
--- a/README.md
+++ b/README.md
@@ -34,16 +34,16 @@ Note that rootfs partitions have to be named `shimboot_rootfs:<partname>` for th
 Driver support depends on the device you are using shimboot on. The `patch_rootfs.sh` script attempts to copy all the firmware and drivers from the shim and recovery image into the rootfs, so expect most things to work on other boards. ARM Chromebooks are not supported at the moment.
 
 ### Device Compatibility Table:
-| Feature \ Board Name | [`dedede`](https://chrome100.dev/board/dedede/) | [`octopus`](https://chrome100.dev/board/octopus/) | [`nissa`](https://chrome100.dev/board/nissa/) | [`reks`](https://chrome100.dev/board/reks/) | [`kefka`](https://chrome100.dev/board/kefka) | [`zork`](https://chrome100.dev/board/zork) |
-|----------------------|-------------------------------------------------|---------------------------------------------------|-----------------------------------------------|---------------------------------------------|----------------------------------------------|--------------------------------------------|
-| X11                  | yes                                             | yes                                               | yes                                           | no <sup>[1]</sup>                           | no <sup>[1]</sup>                            | yes                                        |
-| Wifi                 | yes                                             | yes                                               | yes                                           | yes                                         | yes                                          | yes                                        |
-| Internal Audio       | no                                              | yes                                               | no                                            | untested                                    | yes                                          | no                                         |
-| Backlight            | yes                                             | yes                                               | yes                                           | untested                                    | yes                                          | untested                                   |
-| Touchscreen          | yes                                             | yes                                               | yes                                           | untested                                    | untested                                     | yes                                        |
-| 3D Acceleration      | yes                                             | yes                                               | yes                                           | no                                          | no                                           | yes                                        |
-| Bluetooth            | yes                                             | yes                                               | yes                                           | untested                                    | untested                                     | yes                                        |
-| Webcam               | yes                                             | yes                                               | yes                                           | untested                                    | untested                                     | yes                                        |
+| Feature \ Board Name | [`dedede`](https://chrome100.dev/board/dedede/) | [`octopus`](https://chrome100.dev/board/octopus/) | [`nissa`](https://chrome100.dev/board/nissa/) | [`reks`](https://chrome100.dev/board/reks/) | [`kefka`](https://chrome100.dev/board/kefka) | [`zork`](https://chrome100.dev/board/zork) | [`grunt`](https://chrome100.dev/board/grunt) |
+|----------------------|-------------------------------------------------|---------------------------------------------------|-----------------------------------------------|---------------------------------------------|----------------------------------------------|--------------------------------------------|----------------------------------------------|
+| X11                  | yes                                             | yes                                               | yes                                           | no <sup>[1]</sup>                           | no <sup>[1]</sup>                            | yes                                        | yes                                          |
+| Wifi                 | yes                                             | yes                                               | yes                                           | yes                                         | yes                                          | yes                                        | yes                                          |
+| Internal Audio       | no                                              | yes                                               | no                                            | untested                                    | yes                                          | no                                         | no                                           |
+| Backlight            | yes                                             | yes                                               | yes                                           | untested                                    | yes                                          | untested                                   | yes                                          |
+| Touchscreen          | yes                                             | yes                                               | yes                                           | untested                                    | untested                                     | yes                                        | yes                                          |
+| 3D Acceleration      | yes                                             | yes                                               | yes                                           | no                                          | no                                           | yes                                        | yes                                          |
+| Bluetooth            | yes                                             | yes                                               | yes                                           | untested                                    | untested                                     | yes                                        | yes                                          |
+| Webcam               | yes                                             | yes                                               | yes                                           | untested                                    | untested                                     | yes                                        | yes                                          |
 
 <sup>1. The kernel is too old.</sup>