docs: Add missing chapter emojis

docs: Add missing warning in Advanced docs in summary docs: add missing waydroid guide docs: rename files to avoid spaces docs: fix badly set docs build params docs: remove unnecesary placeholders
ublue-os · KyleGospo · Aug 21, 2024 · Jul 31, 2024 · Jul 31, 2024 · Jul 31, 2024
commit e3be3c62501694cad361789b9d6ac703660c5764
@@ -4,7 +4,9 @@ language = "en"
 multilingual = false
 src = "src"
 title = "Bazzite Documentation"
-use-default-preprocessors = false
 
 [build]
-create-missing = false
+use-default-preprocessors = false
+create-missing = false
+
+[preprocessor.links]
diff --git a/docs/src/Advanced/GRUB Theming.md → docs/src/Advanced/GRUB_Theming.md b/docs/src/Advanced/GRUB Theming.md → docs/src/Advanced/GRUB_Theming.md
diff --git a/...ed/Modifying initramfs args and dracut.md → ...ed/Modifying_initramfs_args_and_dracut.md b/...ed/Modifying initramfs args and dracut.md → ...ed/Modifying_initramfs_args_and_dracut.md
diff --git a/...anced/Plymouth Theming to Show Details.md → ...anced/Plymouth_Theming_to_Show_Details.md b/...anced/Plymouth Theming to Show Details.md → ...anced/Plymouth_Theming_to_Show_Details.md
diff --git a/docs/src/Advanced/Using Looking Glass.md → docs/src/Advanced/Using_Looking_Glass.md b/docs/src/Advanced/Using Looking Glass.md → docs/src/Advanced/Using_Looking_Glass.md
diff --git a/docs/src/Bazzite's README.md b/docs/src/Bazzite's README.md
@@ -0,0 +1 @@
+{{#include ../../README.md}}
@@ -63,4 +63,4 @@ View this [guide](https://universal-blue.discourse.group/docs?topic=970) for for
 
 <hr>
 
-[**<-- Back to Gaming Guide**](README.md)
+[**<-- Back to Gaming Guide**](index.md)
@@ -2,7 +2,7 @@
 
 Linux gaming being a viable competitor to Windows is a relatively new paradigm. Most Windows exclusive games can run on Bazzite using modern hardware. There are still some rough edges, but gaming on Linux does offer advantages on the appropriate hardware such as better frame-times than on Windows.
 
-- # [Game Launchers](Game%20Launchers.md)
+- # [Game Launchers](Game_Launchers.md)
 
   - Setting Up Steam
   - Non-Steam Games

@@ -113,6 +113,6 @@ Hold down the "**select**" button on your device to force a reboot. This feature
 
 This page is a **wiki**, edit it to add any relevant information you may have regarding the handheld and your experience with Bazzite on it. Make sure to follow proper [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) and [contributing guidelines](https://universal-blue.discourse.group/docs?topic=81) before adding any edits.
 
-**See also**: [Steam Gaming Mode Overview](../Steam%20Gaming%20Mode/index.md)
+**See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode/index.md)
 
 **<-- Back to [Handheld Wiki](index.md)**
@@ -90,6 +90,6 @@ Make sure to **apply** the desktop controls when you select them.
 
 This page is a **wiki**, edit it to add any relevant information you may have regarding the handheld and your experience with Bazzite on it. Make sure to follow proper [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) and [contributing guidelines](https://universal-blue.discourse.group/docs?topic=81) before adding any edits.
 
-**See also**: [Steam Gaming Mode Overview](../Steam%20Gaming%20Mode/index.md)
+**See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode/index.md)
 
 **<-- Back to [Handheld Wiki](index.md)**
@@ -92,6 +92,6 @@ Make sure to **apply** the desktop controls when you select them.
 
 This page is a **wiki**, edit it to add any relevant information you may have regarding the handheld and your experience with Bazzite on it. Make sure to follow proper [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) and [contributing guidelines](https://universal-blue.discourse.group/docs?topic=81) before adding any edits.
 
-**See also**: [Steam Gaming Mode Overview](../Steam%20Gaming%20Mode/index.md)
+**See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode/index.md)
 
 **<-- Back to [Handheld Wiki](index.md)**
@@ -108,6 +108,6 @@ Make sure to **apply** the desktop controls when you select them.
 
 This page is a **wiki**, edit it to add any relevant information you may have regarding the handheld and your experience with Bazzite on it. Make sure to follow proper [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) and [contributing guidelines](https://universal-blue.discourse.group/docs?topic=81) before adding any edits.
 
-**See also**: [Steam Gaming Mode Overview](../Steam%20Gaming%20Mode/index.md)
+**See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode/index.md)
 
 **<-- Back to [Handheld Wiki](index.md)**
@@ -96,6 +96,6 @@ Hold down the "**select**" button on your device to force a reboot. This feature
 
 This page is a **wiki**, edit it to add any relevant information you may have regarding the handheld and your experience with Bazzite on it. Make sure to follow proper [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) and [contributing guidelines](https://universal-blue.discourse.group/docs?topic=81) before adding any edits.
 
-**See also**: [Steam Gaming Mode Overview](../Steam%20Gaming%20Mode/index.md)
+**See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode/index.md)
 
 **<-- Back to [Handheld Wiki](./)**
@@ -69,6 +69,6 @@ Make sure to **apply** the desktop controls when you select them.
 
 This page is a **wiki**, edit it to add any relevant information you may have regarding the handheld and your experience with Bazzite on it. Make sure to follow proper [documentation guidelines](https://universal-blue.discourse.group/docs?topic=890) and [contributing guidelines](https://universal-blue.discourse.group/docs?topic=81) before adding any edits.
 
-**See also**: [Steam Gaming Mode Overview](../Steam%20Gaming%20Mode/index.md)
+**See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode/index.md)
 
 **<-- Back to [Handheld Wiki](index.md)**
@@ -121,6 +121,6 @@ This [post](https://universal-blue.discourse.group/t/my-experience-using-bazzite
 
 <hr>
 
-**See also**: [Steam Gaming Mode Overview](../Steam%20Gaming%20Mode/index.md)
+**See also**: [Steam Gaming Mode Overview](../Steam_Gaming_Mode/index.md)
 
 **<-- Back to [Handheld Wiki](index.md)**
@@ -2,13 +2,13 @@
 
 > This list is incomplete and does not indicate that unlisted handhelds do not work with Bazzite currently, but because we lack specific information regarding their post-installation setup, workarounds, and proper support they are unlisted here.
 
-- [Steam Deck](Steam%20Deck.md)
-- [Lenovo Legion Go](Lenovo%20Legion%20Go.md)
-- [ASUS ROG Ally](ASUS%20ROG%20Ally.md)
-- [Ayn Handhelds](Ayn%20Handhelds.md)
-- [GPD Handhelds](GPD%20Handhelds.md)
-- [Ayaneo Handhelds](Ayaneo%20Handhelds.md)
-- [Other Handhelds](Other%20Handhelds.md)
+- [Steam Deck](Steam_Deck.md)
+- [Lenovo Legion Go](Lenovo_Legion_Go.md)
+- [ASUS ROG Ally](ASUS_ROG_Ally.md)
+- [Ayn Handhelds](Ayn_Handhelds.md)
+- [GPD Handhelds](GPD_Handhelds.md)
+- [Ayaneo Handhelds](Ayaneo_Handhelds.md)
+- [Other Handhelds](Other_Handhelds.md)
 
 ## Support Rating
 

@@ -1,6 +1,6 @@
 # General Information
 
-> **For Handheld PC users only**: View our [Handheld Wiki](https://universal-blue.discourse.group/docs?topic=1038) for post-installation setup, workarounds, and known issues on handheld hardware.
+> **For Handheld PC users only**: View our [Handheld Wiki](../Handheld_Wiki/index.md) for post-installation setup, workarounds, and known issues on handheld hardware.
 
 ![Steam Gaming Mode UI|690x430](../../img/Steam_Gaming_Mode_UI.jpg)
 
@@ -82,7 +82,7 @@ Select "unhide" to have GRUB appear on boot.
 
 ## Change physical keyboard layout for Steam Gaming Mode
 
-https://universal-blue.discourse.group/docs?topic=816
+See [Change Physical Keyboard Layout for Steam Gaming Mode](../Change_Physical_Keyboard_Layout_for_Steam_Gaming_Mode.md)
 
 ## Why do specific Decky Loader plugins not function on Bazzite?
 

diff --git a/docs/src/Installing and Managing Software/Waydroid Setup Guide.md b/docs/src/Installing and Managing Software/Waydroid Setup Guide.md
@@ -13,7 +13,7 @@ Flatpaks can be installed via the software center of the desktop environment you
 - **KDE**: _Discover_ ![Discover|50x50, 50%]
 - **GNOME**: _GNOME Software_ ![GNOME Software|50x50, 50%]
   ![Discover|659x500, 100%](../img/Discover.png)
-  ![GNOME Software Center](../img/GNOME%20Software%20Center.png)
+  ![GNOME Software Center](../img/GNOME_Software_Center.png)
 
 **Alternatively open a host terminal and enter**:
 

@@ -11,7 +11,7 @@
 
 # Rollbacks
 
-![GRUB Menu|690x402](../img/GRUB%20Menu.png)
+![GRUB Menu|690x402](../img/GRUB_Menu.png)
 
 > Swap back to a previous system update if there are major issues after updating via the GRUB menu or the `rpm-ostree rollback` command.
 

@@ -0,0 +1,146 @@
+nicknamenamenick | 2024-07-26 23:57:00 UTC | #1
+
+![Waydroid](../img/Waydroid.jpg)
+
+![Google Play Store|650x500](../img/Google_Play_Store.jpg)
+
+> **Note**: Waydroid does **not** work on Nvidia's proprietary drivers, and requires an AMD or Intel GPU for the best results.
+
+# What is Waydroid?
+
+[Waydroid](https://waydro.id/) is an Android container that runs on Linux. Bazzite users can run Android applications using this method.
+
+# First Time Setup
+
+Open a host terminal and **enter this command to setup Waydroid**:
+
+```bash
+ujust setup-waydroid
+```
+
+## Initialize Waydroid
+
+Waydroid requires users to initialize it for the first time which can be done by selecting:
+`Initialize Waydroid`
+
+Make sure this worked by entering this **command**:
+
+```bash
+/usr/bin/waydroid-launcher
+```
+
+This will launch Waydroid for the first time.
+
+## Configure Waydroid
+
+### Part 1: Stop Waydroid Session
+
+Waydroid needs to stop running to configure properly.
+
+Open a host terminal and enter this **command**:
+
+```command
+waydroid session stop
+```
+
+### Part 2: Configuration
+
+Open a host terminal and enter this **command**:
+
+```
+ujust setup-waydroid
+```
+
+Selecting `Configure Waydroid` will allow users to install additional Android tweaks with the [Waydroid Extras Scripts.](https://github.com/casualsnek/waydroid_script#waydroid-extras-script)
+
+1. Select Android Version (**_Android 11_ recommended**)
+2. Select items to install
+   a) [GApps](https://github.com/opengapps/opengapps/wiki/FAQ) (Default Android applications including the **Google Play Store)** or [microG](https://microg.org/) (Free alternatives to Google applications)
+   b) ARM Translation (_libndk_ for **AMD CPUs only** & _libhoudini_ for **Intel CPUs only**)
+   c) [Magisk](https://github.com/topjohnwu/Magisk) (Android power user suite)
+   d) [Logitech Smartdock Support](https://support.logi.com/hc/en-us/articles/360023201574-What-is-SmartDock) (Currently broken)
+   e) [F-Droid Privileged Extension](https://f-droid.org/packages/org.fdroid.fdroid.privileged/) (Proper [F-Droid](https://f-droid.org/en/packages/) support)
+   f) [widevine](https://widevine.com/) (Support for video streaming DRM)
+
+### Get Google Device ID to Get Certified
+
+1. Launch Waydroid
+   (**Waydroid must be running**)
+
+2. After selecting your current Android version, select `Get Google Device ID to Get Certified` especially if you plan to use the Google Play Store (GApps).
+
+3. Follow the instructions in the terminal output.
+
+After verification has happened, it will usually take a while before your device is verified.
+
+# Add as a Non-Steam Shortcut
+
+> This is useful for [Bazzite images that use Steam Gaming Mode.](../Handheld_and_HTPC_edition/Steam_Gaming_Mode/index.md)
+
+Make sure to add the shortcut in `/usr/bin/waydroid-launcher` for Waydroid to work properly in Steam Gaming Mode.
+
+<hr>
+
+# Disable Inputs to Waydroid When Unfocused
+
+Waydroid has an [issue](https://github.com/waydroid/waydroid/issues/135) where it will register inputs from controllers, keyboards, and other input devices even when the window is not focused.
+
+Disable this functionality:
+
+> Note: **Waydroid must be running**!
+
+In a host terminal, **run this command**:
+
+```command
+waydroid prop set persist.waydroid.uevent false
+```
+
+If you ever want to undo this change, run the same steps but set `true` instead of `false` with the same command.
+
+# Resolution & Density Options
+
+> **Note**: This is intended for users who have issues with Waydroid's resolution, scaling, or running Waydroid nested. This is **optional**.
+
+Open a host terminal and enter the following **commands**:
+
+```bash
+sudoedit /etc/default/waydroid-launcher
+```
+
+```bash
+sudoedit /etc/default/steamos-nested-desktop
+```
+
+Save the text files when done.
+
+# Waydroid Hybrid Graphics Fix
+
+> **Note**: This is only intended for users who have multiple GPUs in their hardware who experience graphical corruptions in Waydroid.
+
+**Enter in a host terminal**:
+
+```
+ujust setup-waydroid
+```
+
+Then `Select GPU for Waydroid` which will give the option on what GPU to utilize for Waydroid to fix graphical corruptions.
+
+<hr>
+
+# Reset Waydroid
+
+> **Warning**: You will lose all of your Waydroid data.
+
+If you experience issues or want a fresh Waydroid container, then select `Reset Waydroid` after **entering**:
+
+```
+ujust setup-waydroid
+```
+
+<hr>
+
+**Documentation Contributors**: [Kyle Gospo](https://github.com/KyleGospo), [Gecked-Deck](https://github.com/Gecked-Deck), [Nathaniel Warburton](https://github.com/storyaddict), and [Jorge Castro](https://github.com/castrojo)
+
+**See also**: [Upstream documentation](https://docs.waydro.id/)
+
+<-- [**View all Bazzite documentation**](https://universal-blue.discourse.group/docs?topic=561)
@@ -30,7 +30,7 @@ nicknamenamenick | 2024-07-31 15:11:34 UTC | #1
 
 # How do I install Android applications?
 
-Follow the [Waydroid Setup Guide](Waydroid%20Setup%20Guide.md) to install Android applications on Bazzite.
+Follow the [Waydroid Setup Guide](Waydroid_Setup_Guide.md) to install Android applications on Bazzite.
 
 > **Note**: Waydroid is **not supported** on other Universal Blue images like Aurora and Bluefin.
 
@@ -51,4 +51,4 @@ Follow the [Waydroid Setup Guide](Waydroid%20Setup%20Guide.md) to install Androi
 
 **Documentation Contributors**: [HikariKnight](https://github.com/HikariKnight)
 
-**See also**: [Updates, Rollbacks, & Rebasing](Updates,%20Rollbacks,%20&%20Rebasing.md)
+**See also**: [Updates, Rollbacks, & Rebasing](Updates_Rollbacks_&_Rebasing.md)
@@ -1,49 +1,49 @@
-# Summary
-
 # General
 
-- [Bazzite's README](Bazzite's%20README.md)
-- [FAQ](General/FAQ.md)
-- [Installation Guide](General/Installation%20Guide/index.md)
-- [Desktop Environment Tweaks](General/Desktop%20Environment%20Tweaks.md)
-- [Contributing to Bazzite](General/Contributing%20to%20Bazzite.md)
+- [📜 Bazzite's README](Bazzite_README.md)
+- [❓️ FAQ](General/FAQ.md)
+- [📖 Installation Guide](General/Installation_Guide/index.md)
+- [📝 Desktop Environment Tweaks](General/Desktop_Environment_Tweaks.md)
+- [🤝 Contributing to Bazzite](General/Contributing_to_Bazzite.md)
 
-# Gaming
+# 🎲 Gaming
 
 - [Introduction](Gaming/index.md)
-- [Game Launchers](Gaming/Game%20Launchers.md)
+- [Game Launchers](Gaming/Game_Launchers.md)
 
 # Steam Gaming Mode / Handheld & HTPC Hardware
 
-- [Steam Gaming Mode Overview](Handheld%20and%20HTPC%20edition/Steam%20Gaming%20Mode/index.md)
-- [Handheld Wiki](Handheld%20and%20HTPC%20edition/Handheld%20Wiki/index.md)
-  - [Steam Deck](Handheld%20and%20HTPC%20edition/Handheld%20Wiki/Steam%20Deck.md)
-  - [Lenovo Legion Go](Handheld%20and%20HTPC%20edition/Handheld%20Wiki/Lenovo%20Legion%20Go.md)
-  - [ASUS ROG Ally](Handheld%20and%20HTPC%20edition/Handheld%20Wiki/ASUS%20ROG%20Ally.md)
-  - [Ayn Handhelds](Handheld%20and%20HTPC%20edition/Handheld%20Wiki/Ayn%20Handhelds.md)
-  - [GPD Handhelds](Handheld%20and%20HTPC%20edition/Handheld%20Wiki/GPD%20Handhelds.md)
-  - [Ayaneo Handhelds](Handheld%20and%20HTPC%20edition/Handheld%20Wiki/Ayaneo%20Handhelds.md)
-  - [Other Handhelds](Handheld%20and%20HTPC%20edition/Handheld%20Wiki/Other%20Handhelds.md)
-- [Change Physical Keyboard Layout for Steam Gaming Mode](Handheld%20and%20HTPC%20edition/Change%20Physical%20Keyboard%20Layout%20for%20Steam%20Gaming%20Mode.md)
+- [📺️ Steam Gaming Mode Overview](Handheld_and_HTPC_edition/Steam_Gaming_Mode/index.md)
+  - [Change Physical Keyboard Layout for Steam Gaming Mode](Handheld_and_HTPC_edition/Change_Physical_Keyboard_Layout_for_Steam_Gaming_Mode.md)
+- [Handheld Wiki](Handheld_and_HTPC_edition/Handheld_Wiki/index.md)
+  - [Steam Deck](Handheld_and_HTPC_edition/Handheld_Wiki/Steam_Deck.md)
+  - [Lenovo Legion Go](Handheld_and_HTPC_edition/Handheld_Wiki/Lenovo_Legion_Go.md)
+  - [ASUS ROG Ally](Handheld_and_HTPC_edition/Handheld_Wiki/ASUS_ROG_Ally.md)
+  - [Ayn Handhelds](Handheld_and_HTPC_edition/Handheld_Wiki/Ayn_Handhelds.md)
+  - [GPD Handhelds](Handheld_and_HTPC_edition/Handheld_Wiki/GPD_Handhelds.md)
+  - [Ayaneo Handhelds](Handheld_and_HTPC_edition/Handheld_Wiki/Ayaneo_Handhelds.md)
+  - [Other Handhelds](Handheld_and_HTPC_edition/Handheld_Wiki/Other_Handhelds.md)
 
 # Software
 
-- [Installing and Managing Software](Installing%20and%20Managing%20Software/index.md)
-  - [Flatpak](Installing%20and%20Managing%20Software/Flatpak.md)
-  - [ujust](Installing%20and%20Managing%20Software/ujust.md)
-  - [Homebrew](Installing%20and%20Managing%20Software/Homebrew.md)
-  - [Distrobox](Installing%20and%20Managing%20Software/Distrobox.md)
-  - [Appimage](Installing%20and%20Managing%20Software/AppImage.md)
-  - [rpm-ostree](Installing%20and%20Managing%20Software/rpm-ostree.md)
-  - [Waydroid Setup Guide](Installing%20and%20Managing%20Software/Waydroid%20Setup%20Guide.md)
-  - [Tutorials for Installing Other Software](Installing%20and%20Managing%20Software/index.md)
-- [Updates, Rollbacks, & Rebasing](Installing%20and%20Managing%20Software/Updates,%20Rollbacks,%20&%20Rebasing.md)
+- [Installing and Managing Software](Installing_and_Managing_Software/index.md)
+  - [Flatpak](Installing_and_Managing_Software/Flatpak.md)
+  - [ujust](Installing_and_Managing_Software/ujust.md)
+  - [Homebrew](Installing_and_Managing_Software/Homebrew.md)
+  - [Distrobox](Installing_and_Managing_Software/Distrobox.md)
+  - [Appimage](Installing_and_Managing_Software/AppImage.md)
+  - [rpm-ostree](Installing_and_Managing_Software/rpm-ostree.md)
+  - [Waydroid Setup Guide](Installing_and_Managing_Software/Waydroid_Setup_Guide.md)
+  - [Tutorials for Installing Other Software](Installing_and_Managing_Software/index.md)
+- [Updates, Rollbacks, & Rebasing](Installing_and_Managing_Software/Updates_Rollbacks_&_Rebasing.md)
 
 # Advanced
 
-- [Auto-Mounting Secondary Drives](Advanced/Auto-Mounting%20Secondary%20Drives.md)
-- [Reset User Password](Advanced/Reset%20User%20Password.md)
-- [Using Looking Glass](Advanced/Using%20Looking%20Glass.md)
-- [Plymouth Theming to Show Details](Advanced/Plymouth%20Theming%20to%20Show%20Details.md)
-- [GRUB Theming](Advanced/GRUB%20Theming.md)
-- [Modifying initramfs args and dracut](Advanced/Modifying%20initramfs%20args%20and%20dracut.md)
+##### **_Follow the documentation below at your own risk!_**
+
+- [Auto-Mounting Secondary Drives](Advanced/Auto-Mounting_Secondary_Drives.md)
+- [Reset User Password](Advanced/Reset_User_Password.md)
+- [Using Looking Glass](Advanced/Using_Looking_Glass.md)
+- [Plymouth Theming to Show Details](Advanced/Plymouth_Theming_to_Show_Details.md)
+- [GRUB Theming](Advanced/GRUB_Theming.md)
+- [Modifying initramfs args and dracut](Advanced/Modifying_initramfs_args_and_dracut.md)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -63,4 +63,4 @@ View this [guide](https://universal-blue.discourse.group/docs?topic=970) for for

		<hr>

		[<-- Back to Gaming Guide](README.md)
		[<-- Back to Gaming Guide](index.md)