docs: fix broken links

MauriceNino · Jan 21, 2024 · dbbe809 · dbbe809
1 parent 782fe15
commit dbbe809
Show file tree

Hide file tree

Showing 10 changed files with 23 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -63,8 +63,8 @@ In case you want to financially support this project, you can visit my
 
 ## Documentation
 
-- [Installation Options](https://getdashdot.com/docs/install)
-- [Configuration Options](https://getdashdot.com/docs/config)
+- [Installation Options](https://getdashdot.com/docs/installation)
+- [Configuration Options](https://getdashdot.com/docs/configuration)
 - [Contributing](./.github/CONTRIBUTING.md)
 - [Changelog](./.github/CHANGELOG.md)
 
@@ -83,6 +83,6 @@ docker container run -it \
 
 To get more information on why which flag is needed, or if you want to use other
 install options instead (`docker-compose`, or from source), have a look at the
-[installation options](https://getdashdot.com/docs/install).
+[installation options](https://getdashdot.com/docs/installation).
 
-To read more about configuration options, you can visit the [configuration options](https://getdashdot.com/docs/config).
+To read more about configuration options, you can visit the [configuration options](https://getdashdot.com/docs/configuration).
diff --git a/apps/docs/docs/configuration/cpu.mdx b/apps/docs/docs/configuration/cpu.mdx
@@ -39,13 +39,13 @@ For home servers it might work just fine.
 :::note
 
 If you want to show the data using imperial units, you need to set the
-[`DASHDOT_USE_IMPERIAL`](/docs/configuration/basic#dashdot_use_imperial) option to `true`.
+[`DASHDOT_USE_IMPERIAL`](./basic#dashdot_use_imperial) option to `true`.
 
 :::
 
 ### `DASHDOT_CPU_TEMPS_MODE`
 
-To choose between average and max CPU temperature (accross all cores). Needs [`DASHDOT_ENABLE_CPU_TEMPS`](/docs/configuration/cpu#dashdot_enable_cpu_temps) enabled to work.
+To choose between average and max CPU temperature (accross all cores). Needs [`DASHDOT_ENABLE_CPU_TEMPS`](./cpu#dashdot_enable_cpu_temps) enabled to work.
 
 The available options are: `avg`, `max`.
 

diff --git a/apps/docs/docs/configuration/gpu.mdx b/apps/docs/docs/configuration/gpu.mdx
@@ -12,8 +12,8 @@ title: GPU
 
 :::note
 
-- To use the GPU widget, make sure to include it in the [`DASHDOT_WIDGET_LIST`](/docs/configuration/basic#dashdot_widget_list).
-- Also, if you are running the docker image, make sure to use the `nvidia` tag (see [Installation with Docker](/docs/installation/docker#gpu-support)).
+- To use the GPU widget, make sure to include it in the [`DASHDOT_WIDGET_LIST`](./basic#dashdot_widget_list).
+- Also, if you are running the docker image, make sure to use the `nvidia` tag (see [Installation with Docker](../installation/docker#gpu-support)).
 
 :::
 

diff --git a/apps/docs/docs/configuration/server.mdx b/apps/docs/docs/configuration/server.mdx
@@ -36,7 +36,7 @@ If you want to show the host part in the server widget (e.g. `dash.` -> `dash.ma
 
 ### `DASHDOT_CUSTOM_HOST`
 
-If you want to show a custom host in the server widget (needs [`DASHDOT_SHOW_HOST`](/docs/configuration/basic#dashdot_show_host) enabled to work).
+If you want to show a custom host in the server widget (needs [`DASHDOT_SHOW_HOST`](#dashdot_show_host) enabled to work).
 
 - type: `string`
 - default: `unset`

diff --git a/apps/docs/docs/help.mdx b/apps/docs/docs/help.mdx
@@ -12,7 +12,7 @@ tags:
 
 In earlier versions, the top-left percentage labels were on by default, but due to UX decisions, they are now
 only enabled on mobile devices. If you want to bring back the old behavior, there is the flag
-[`DASHDOT_ALWAYS_SHOW_PERCENTAGES`](/docs/configuration/basic#dashdot_always_show_percentages) for that.
+[`DASHDOT_ALWAYS_SHOW_PERCENTAGES`](./configuration/basic#dashdot_always_show_percentages) for that.
 
 ### The network information can not be read correctly - what should I do?
 
@@ -22,7 +22,7 @@ bind mount. If you have done so, and it still does not work, please do the follo
 > Check your logs for a message like `Using network interface "xxxxx"`.
 
 **Is this the correct network interface?** If not, please find out your default interface, and pass the name
-manually, using the [`DASHDOT_USE_NETWORK_INTERFACE`](/docs/configuration/network#dashdot_use_network_interface) flag.
+manually, using the [`DASHDOT_USE_NETWORK_INTERFACE`](./configuration/network#dashdot_use_network_interface) flag.
 
 If it **is** the correct network interface, please open a GitHub issue with the relevant log outputs and information.
 

diff --git a/apps/docs/docs/installation/from-source.mdx b/apps/docs/docs/installation/from-source.mdx
@@ -18,7 +18,7 @@ To run this repository from source, you need to have the following installed:
 - [git](https://git-scm.com/)
 - [speedtest](https://www.speedtest.net/apps/cli) (recommended)
   - or alternatively: [speedtest-cli](https://github.com/sivel/speedtest-cli)
-  - or alternatively: [use local file](/docs/configuration/network#dashdot_speed_test_from_path)
+  - or alternatively: [use local file](../configuration/network#dashdot_speed_test_from_path)
 
 ## Setup
 

diff --git a/apps/docs/docs/installation/index.md b/apps/docs/docs/installation/index.md
@@ -25,7 +25,7 @@ docker container run -it \
 
 - The volume mounts on `/:/mnt/host:ro` is needed to read the usage stats of all drives,
   read the network usage and read the os version of the host. If you don't like to use this
-  mount, feel free to check out the [help page](/docs/help#can-you-use-dash-without-mounting-the-whole-host-drive) to find a guide on how to set it up manually.
+  mount, feel free to check out the [help page](./help#can-you-use-dash-without-mounting-the-whole-host-drive) to find a guide on how to set it up manually.
 
 :::
 
@@ -34,14 +34,14 @@ docker container run -it \
 The speed testing feature can consume significant amounts of bandwidth, which can pose
 problems if your usage is metered (say, by a VPS provider).
 
-Setting the environment variable [`DASHDOT_SPEED_TEST_INTERVAL`](/docs/configuration/network#dashdot_speed_test_interval)
+Setting the environment variable [`DASHDOT_SPEED_TEST_INTERVAL`](./configuration/network#dashdot_speed_test_interval)
 to a higher number can mitigate this concern.
 
 :::
 
 ## Windows / MacOS
 
-If you want to install Dash. on Windows or MacOS, you will have to use the [from source](/docs/installation/from-source)
+If you want to install Dash. on Windows or MacOS, you will have to use the [from source](./installation/from-source)
 installation, as Docker Desktop is technologically impossible to support.
 
 ## Installation Options

diff --git a/apps/docs/docusaurus.config.js b/apps/docs/docusaurus.config.js
@@ -74,11 +74,11 @@ const config = {
             items: [
               {
                 label: 'Installation',
-                to: '/docs/installation',
+                to: 'docs/installation',
               },
               {
                 label: 'Configuration',
-                to: '/docs/configuration',
+                to: 'docs/configuration/basic',
               },
               {
                 label: 'Changelog',

diff --git a/apps/docs/src/pages/index.tsx b/apps/docs/src/pages/index.tsx
@@ -30,11 +30,14 @@ const HomepageHeader = () => {
       <div className={styles.buttons}>
         <Link
           className='button button--secondary button--lg'
-          to='/docs/install'
+          to='/docs/installation'
         >
           Installation
         </Link>
-        <Link className='button button--secondary button--lg' to='/docs/config'>
+        <Link
+          className='button button--secondary button--lg'
+          to='/docs/configuration/basic'
+        >
           Configuration
         </Link>
       </div>

diff --git a/apps/server/src/data/network.ts b/apps/server/src/data/network.ts
@@ -167,7 +167,7 @@ export default {
         using DASHDOT_SPEEDTEST_FROM_PATH.
   
         For more help on how to setup dashdot, look here:
-        https://getdashdot.com/docs/install/from-source
+        https://getdashdot.com/docs/installation/from-source
       `);
     }