From e7a09dc5713f4faf812289597506b8f422122757 Mon Sep 17 00:00:00 2001
From: elkowar <5300871+elkowar@users.noreply.github.com>
Date: Fri, 14 May 2021 20:07:47 +0200
Subject: [PATCH] Slightly clean up docs

---
 docs/content/main/_index.md           |  5 +++++
 docs/content/main/troubleshooting.md  | 16 +++++++++++++---
 docs/content/main/working_with_gtk.md |  2 +-
 3 files changed, 19 insertions(+), 4 deletions(-)

diff --git a/docs/content/main/_index.md b/docs/content/main/_index.md
index d8680eb..505b720 100644
--- a/docs/content/main/_index.md
+++ b/docs/content/main/_index.md
@@ -40,6 +40,11 @@ and then to build:
 ```bash
 cargo build --release
 ```
+**NOTE:**
+When you're on wayland, build with:
+```bash
+cargo build --release --no-default-features --features=x11
+```
 
 ### Running eww
 Once you've built it you can now run it by entering:
diff --git a/docs/content/main/troubleshooting.md b/docs/content/main/troubleshooting.md
index e5f3ae9..6190d3d 100644
--- a/docs/content/main/troubleshooting.md
+++ b/docs/content/main/troubleshooting.md
@@ -8,23 +8,33 @@ weight = 4
 
 Here you will find help if something doesn't work, if the issue isn't listed here please [open an issue on the GitHub repo.](https://github.com/elkowar/eww/issues)
 
+### Eww does not compile
+
+1. Make sure that you are compiling eww using the nightly rust toolchain.
+2. Make sure you have all the necessary dependencies. If there are compile-errors, the compiler will tell you what you're missing.
+
+### Eww does not work on wayland
+
+1. Make sure you compiled eww with the `--no-default-features --feature=wayland` flags.
+2. Make sure that you're not trying to use X11-specific features (these are (hopefully) explicitly specified as such in the documentation).
+
 ### My scss isn't being loaded!
 
 1. You have not created a scss file
 2. The scss file isn't called correctly. (it should be called `eww.scss` in the `$HOME/.config/eww` folder)
 3. The scss file isn't placed in the correct location (check above)
 
-If none of these fixed your problem [open an issue on the GitHub repo.](https://github.com/elkowar/eww/issues) Or check the [GTK-Debugger](#gtk-debugger).
+If none of these fixed your problem [open an issue on the GitHub repo](https://github.com/elkowar/eww/issues), or check the [GTK-Debugger](@/main/working_with_gtk.md#gtk-debugger).
 
 ### Eww can't find my configuration file!
 
 1. It's incorrectly named or it's in the wrong place  (it should be called `eww.xml` in the `$HOME/.config/eww` folder)
-2. You haven't started eww correctly or you started it wrong. (See [Starting  Eww](starting-eww))
+2. You haven't started eww correctly or you started it wrong.
 
 ### Something isn't styled correctly!
 
 1. You have mistyped the CSS class.
-2. Check the [GTK-Debugger](#gtk-debugger)
+2. Check the [GTK-Debugger](@/main/working_with_gtk.md#gtk-debugger)
 
 ### General issues
 
diff --git a/docs/content/main/working_with_gtk.md b/docs/content/main/working_with_gtk.md
index ec17ad9..d12a732 100644
--- a/docs/content/main/working_with_gtk.md
+++ b/docs/content/main/working_with_gtk.md
@@ -18,7 +18,7 @@ If you have **NO** clue about how to do CSS, check out some online guides or tut
 
 SCSS is _very_ close to CSS so if you know CSS you'll have no problem learning SCSS.
 
-### GTK-Debugger
+### GTK-Debugger {#gtk-debugger}
 
 The debugger can be used for **a lot** of things. Especially if something doesn't work or isn't styled right. to enable it launch your eww daemon with