From ddf01792b7c2e8b503f28ac43ad51a0c546b7b99 Mon Sep 17 00:00:00 2001
From: kurtis-lew <kurtis.a.lew@gmail.com>
Date: Tue, 1 Sep 2020 22:08:13 -0700
Subject: [PATCH] Adjusted troubleshooting docs

- References KChen's edits for Env. Variables
- Included troubleshooting page in sidebar
- Adjusted docs to use the <foo> convention
---
 docs/docs/troubleshooting.md | 74 ++----------------------------------
 docs/sidebars.js             |  2 +
 2 files changed, 6 insertions(+), 70 deletions(-)

diff --git a/docs/docs/troubleshooting.md b/docs/docs/troubleshooting.md
index ca70e6a8..a87fee42 100644
--- a/docs/docs/troubleshooting.md
+++ b/docs/docs/troubleshooting.md
@@ -3,90 +3,24 @@ id: troubleshooting
 title: Troubleshooting
 sidebar_title: Troubleshooting
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 
-export const OsTabs = (props) => (<Tabs
-groupId="operating-systems"
-defaultValue="debian"
-values={[
-{label: 'Debian/Ubuntu', value: 'debian'},
-{label: 'Raspberry OS', value: 'raspberryos'},
-{label: 'Fedora', value: 'fedora'},
-{label: 'Windows', value: 'win'},
-{label: 'macOS', value: 'mac'},
-]
-}>{props.children}</Tabs>);
+The following page provides suggestions for common errors that may occur during firmware compilation. If the information provided is insufficient to resolve the issue, feel free to seek out help from the [ZMK Discord](https://discord.gg/VJnx9kr).
 
 ### Environment Variables not Defined
 
 An error along the lines of `CMake Error at (zmk directory)/zephyr/cmake/generic_toolchain.cmake:64 (include): include could not find load file:` during firmware compilation indicates that the Zephyr Environment Variables are not properly defined.
-
-| ![Example Error Screen](../docs/assets/troubleshooting/env_variables/errorscreen.png)  |
-| :-------------------------------------------------------------------------------:      |
-|            An example of the CMake Error on Windows 10                                 |
-
-<OsTabs>
-
-<TabItem value="debian">
-To be completed!
-</TabItem>
-
-<TabItem value="raspberryos">
-To be completed!
-</TabItem>
-
-<TabItem value="fedora">
-To be completed!
-</TabItem>
-
-<TabItem value="win">
-
-On Windows 10, navigate to the System Environment Variables page using the search bar.
-
-![Search Bar Screen](../docs/assets/troubleshooting/env_variables/win1.png)
-
-Click the button labelled 'Environment Variables'
-
-![System Properties Page](../docs/assets/troubleshooting/env_variables/win2.png)
-
-Add a new System Variable labelled `ZEPHYR_TOOLCHAIN_VARIANT` with a value of `gnuarmemb`.
-
-![Environment Variables Page](../docs/assets/troubleshooting/env_variables/win3.png)
-
-![New System Variable - ZEPHYR_TOOLCHAIN_VARIANT](../docs/assets/troubleshooting/env_variables/win4.png)
-
-Repeat the previous steps to create another System Variable called `GNUARMEMB_TOOLCHAIN_PATH` with a value of the directory containing the GNU Arm Embedded Toolchain. 
-
-![New System Variable - GNUARMEMB_TOOLCHAIN_PATH](../docs/assets/troubleshooting/env_variables/win5.png)
-
-:::note
-The folder for the GNUARMEMB_TOOLCHAIN_PATH should look something like this inside:
-
-![GNUARMEMB_TOOLCHAIN_PATH Contents](../docs/assets/troubleshooting/env_variables/win6.png)
-:::
-
-Restart any terminals used to build firmware to check if the errors have been resolved.
-
-
-</TabItem>
-
-<TabItem value="mac">
-To be completed!
-</TabItem>
-
-</OsTabs>
+For more information, click [here](../docs/dev-setup#environment-variables).
 
 ### Improperly defined keymap
 
-An error along the lines of `dtlib.DTError: BOARDNAME.dts.pre.tmp:LINENUMBER` during firmware compilation indicates an issue within the `shield.keymap` file.
+An error along the lines of `dtlib.DTError: <board>.dts.pre.tmp:<line number>` during firmware compilation indicates an issue within the `<shield>.keymap` file.
 This can be verified by checking the file in question, found in `mkdir/app/build`.
 
 |       ![Example Error Screen](../docs/assets/troubleshooting/keymaps/errorscreen.png)                                             |
 | :-------------------------------------------------------------------------------:                                                 |
 |            An example of the dtlib.DTError when compiling an iris with the nice!nano while the keymap is not properly defined     |
 
-After opening the `BOARDNAME.dts.pre.tmp:LINENUMBER` and scrolling down to the referenced line, one can locate errors within their shield's keymap by checking if the referenced keycodes were properly converted into the correct [USB HID Usage ID](https://www.usb.org/document-library/hid-usage-tables-12).
+After opening the `<board>.dts.pre.tmp:<line number>` and scrolling down to the referenced line, one can locate errors within their shield's keymap by checking if the referenced keycodes were properly converted into the correct [USB HID Usage ID](https://www.usb.org/document-library/hid-usage-tables-12).
 
 |       ![Unhealthy Keymap Temp](../docs/assets/troubleshooting/keymaps/unhealthyEDIT.png)  |
 | :-------------------------------------------------------------------------------: |
diff --git a/docs/sidebars.js b/docs/sidebars.js
index 53c5cf3d..ba9715ef 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -24,5 +24,7 @@ module.exports = {
       "dev-tests",
     ],
     "Dev Guides": ["dev-guide-new-shield", "dev-guide-usb-logging"],
+
+    Troubleshooting:["troubleshooting"],
   },
 };