From f6659e6641c99809552913a8abd25ccb9a32bced Mon Sep 17 00:00:00 2001
From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com>
Date: Fri, 30 Aug 2024 19:35:44 -0400
Subject: [PATCH] docs: add interactive table of contents (#3111)
---
DOCKER_README.md | 5 +++++
README.md | 11 ++++++++---
docs/app_examples.md | 5 +++++
docs/building.md | 5 +++++
docs/changelog.md | 5 +++++
docs/configuration.md | 5 +++++
docs/contributing.md | 5 +++++
docs/gamestream_migration.md | 5 +++++
docs/getting_started.md | 5 +++++
docs/guides.md | 5 +++++
docs/legal.md | 5 +++++
docs/performance_tuning.md | 5 +++++
docs/third_party_packages.md | 5 +++++
docs/troubleshooting.md | 5 +++++
14 files changed, 73 insertions(+), 3 deletions(-)
diff --git a/DOCKER_README.md b/DOCKER_README.md
index 2ff7bbf88..0d9d1f4c8 100644
--- a/DOCKER_README.md
+++ b/DOCKER_README.md
@@ -169,3 +169,8 @@ The architectures supported by these images are shown in the table below.
| [Changelog](docs/changelog.md) | [Third-Party Packages](docs/third_party_packages.md) |
+
+
+
+ [TOC]
+
diff --git a/README.md b/README.md
index c99785aba..6c182058f 100644
--- a/README.md
+++ b/README.md
@@ -146,8 +146,13 @@ Our support methods are listed in our [LizardByte Docs](https://lizardbyte.readt
-| Previous | Next |
-|:---------|------------------------------------:|
-| | [Overview](docs/getting_started.md) |
+| Previous | Next |
+|:---------|-------------------------------------------:|
+| | [Getting Started](docs/getting_started.md) |
+
+
+
+ [TOC]
+
diff --git a/docs/app_examples.md b/docs/app_examples.md
index 990064de0..33ad3c348 100644
--- a/docs/app_examples.md
+++ b/docs/app_examples.md
@@ -323,3 +323,8 @@ values in most JSON.}
| [Configuration](configuration.md) | [Guides](guides.md) |
+
+
+
+ [TOC]
+
diff --git a/docs/building.md b/docs/building.md
index 502b0a1cb..6d0e7c475 100644
--- a/docs/building.md
+++ b/docs/building.md
@@ -160,3 +160,8 @@ It may be beneficial to build remotely in some cases. This will enable easier bu
| [Troubleshooting](troubleshooting.md) | [Contributing](contributing.md) |
+
+
+
+ [TOC]
+
diff --git a/docs/changelog.md b/docs/changelog.md
index f975767a2..9cf35f269 100644
--- a/docs/changelog.md
+++ b/docs/changelog.md
@@ -15,3 +15,8 @@
| [Getting Started](getting_started.md) | [Docker](../DOCKER_README.md) |
+
+
+
+ [TOC]
+
diff --git a/docs/configuration.md b/docs/configuration.md
index 98bab79a0..fe1d3b7e1 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -2454,3 +2454,8 @@ editing the `conf` file in a text editor. Use the examples as reference.
| [Legal](legal.md) | [App Examples](app_examples.md) |
+
+
+
+ [TOC]
+
diff --git a/docs/contributing.md b/docs/contributing.md
index 33b780625..22e30f115 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -193,3 +193,8 @@ maintainers to run the tests locally.
| [Building](building.md) | [Source Code](../third-party/doxyconfig/docs/source_code.md) |
+
+
+
+ [TOC]
+
diff --git a/docs/gamestream_migration.md b/docs/gamestream_migration.md
index 274ad0e05..8a8699b75 100644
--- a/docs/gamestream_migration.md
+++ b/docs/gamestream_migration.md
@@ -29,3 +29,8 @@ Sunshine does have some limitations, as compared to Nvidia GameStream.
| [Third-party Packages](third_party_packages.md) | [Legal](legal.md) |
+
+
+
+ [TOC]
+
diff --git a/docs/getting_started.md b/docs/getting_started.md
index a9bd55613..d121813ea 100644
--- a/docs/getting_started.md
+++ b/docs/getting_started.md
@@ -570,4 +570,9 @@ Tutorials and Guides are community generated. Want to contribute? Reach out to u
+
+
+ [TOC]
+
+
[latest-release]: https://github.com/LizardByte/Sunshine/releases/latest
diff --git a/docs/guides.md b/docs/guides.md
index c0f592d7a..2069a3b53 100644
--- a/docs/guides.md
+++ b/docs/guides.md
@@ -532,3 +532,8 @@ going up and down. This device will be referred to as Voicemeeter Input.}
| [App Examples](app_examples.md) | [Performance Tuning](performance_tuning.md) |
+
+
+
+ [TOC]
+
diff --git a/docs/legal.md b/docs/legal.md
index aee2effea..161791a6f 100644
--- a/docs/legal.md
+++ b/docs/legal.md
@@ -25,3 +25,8 @@ concerns about using Sunshine in a commercial setting, we recommend consulting w
| [Gamestream Migration](gamestream_migration.md) | [Configuration](configuration.md) |
+
+
+
+ [TOC]
+
diff --git a/docs/performance_tuning.md b/docs/performance_tuning.md
index e055d5aa7..796121425 100644
--- a/docs/performance_tuning.md
+++ b/docs/performance_tuning.md
@@ -18,3 +18,8 @@ Enabling *Fast Sync* in Nvidia settings may help reduce latency.
| [Guides](guides.md) | [Troubleshooting](troubleshooting.md) |
+
+
+
+ [TOC]
+
diff --git a/docs/third_party_packages.md b/docs/third_party_packages.md
index e89dd19b6..1793b4ce0 100644
--- a/docs/third_party_packages.md
+++ b/docs/third_party_packages.md
@@ -24,3 +24,8 @@
| [Docker](../DOCKER_README.md) | [Gamestream Migration](gamestream_migration.md) |
+
+
+
+ [TOC]
+
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
index baf106f19..3eb72cf8f 100644
--- a/docs/troubleshooting.md
+++ b/docs/troubleshooting.md
@@ -198,3 +198,8 @@ permissions on the disk.
| [Performance Tuning](performance_tuning.md) | [Building](building.md) |
+
+
+
+ [TOC]
+