refactor: rework documentation (#38)

Co-authored-by: Manuel <[email protected]>

README.md

@@ -5,21 +5,21 @@ This is the documentation about homarr (Docuzaurus)
 ### Installation
 
 ```
-$ yarn
+$ pnpm install
 ```
 
 ### Local Development
 
 ```
-$ yarn start
+$ pnpm start
 ```
 
 This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
 
 ### Build
 
 ```
-$ yarn build
+$ pnpm build
 ```
 
 This command generates static content into the `build` directory and can be served using any static contents hosting app.

blog/2023-01-11-version0.11.md

@@ -59,7 +59,7 @@ We'll continute to improve this system according to your feedback.
 Widgets are now much snappier and have been completly recoded.
 This fixes some of the bugs a few users have previously experienced and improves overall customization.
 
-![](../docs/dashboards/widgets/img/choose-widget-in-modal.webp)
+![](../docs/widgets/img/choose-widget-in-modal.webp)
 
 ## Fancy icon picker for speeding up your creation process
 

docs/advanced/_category_.json

@@ -0,0 +1,9 @@
+{
+  "label": "Advanced",
+  "collapsed": true,
+  "position": 4,
+  "link": {
+    "type": "generated-index",
+    "title": "Advanced Concepts or features"
+  }
+}

docs/advanced/configuration/environment-variables.mdx

@@ -59,7 +59,7 @@ This will enable you to control a completly different machine over your network.
 | --------------------- | -------------------- | --------- |
 | ``TZ``                | Any TZ identifier from [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) | your local time zone |
 
-Some users might experience wrong dates/times in their [Calendar](/docs/dashboards/widgets/calendar-widget). This is because the Calendar is using the server-side time. Although you should always set your host machine to your local time zone, you should specify the timezone for Homarr to ensure that the timezone is always set correctly.
+Some users might experience wrong dates/times in their [Calendar](/docs/widgets/calendar-widget). This is because the Calendar is using the server-side time. Although you should always set your host machine to your local time zone, you should specify the timezone for Homarr to ensure that the timezone is always set correctly.
 
 :::tip
 

docs/advanced/sso.mdx

@@ -25,7 +25,7 @@ Multiple providers can be enabled with by separating them with `,`, (ex. `AUTH_P
 
     This is the default provider.
 
-    First user is created using the onboarding process and the rest can be created by this user (see [user management](../management/resources/users))
+    First user is created using the onboarding process and the rest can be created by this user (see [user management](/docs/management/users))
 
   </TabItem>
   <TabItem value="ldap" label="LDAP provider">

docs/community/_category_.json

@@ -0,0 +1,9 @@
+{
+  "label": "More",
+  "position": 5,
+  "collapsed": true,
+  "link": {
+    "type": "generated-index",
+    "title": "More"
+  }
+}

docs/dashboards/widgets/indexer-manager/index.mdx

@@ -6,7 +6,7 @@ tags:
   - Configuration
 ---
 
-The Indexer Manager widget uses [Integrations](/docs/management/integrations/) to display Indexers status with their name.
+The Indexer Manager widget uses [Integrations](/docs/category/integrations) to display Indexers status with their name.
 
 ---
 ## Adding the widget

docs/getting-started/_category_.json

@@ -0,0 +1,9 @@
+{
+  "label": "Getting started",
+  "position": 1,
+  "collapsed": false,
+  "link": {
+    "type": "generated-index",
+    "title": "Getting started"
+  }
+}

docs/dashboards/apps/index.md → docs/getting-started/adding-an-app.mdx

@@ -1,6 +1,6 @@
 ---
-title: Adding an app
-sidebar_position: 2
+title: ➕ Adding an app
+sidebar_position: 4
 tags:
   - Apps
   - Layout
@@ -12,23 +12,21 @@ tags:
   - Line clamp
 ---
 
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 
 Apps are the main components of your board.
 An app can be any application in your network or any public website on the Internet.
 Each app currently must have a HTTP/S URL.
 The behaviour, appearance and other factors of apps can be adjusted.
 
-Please have a look at the [getting started guide](../../getting-started/after-the-installation#adding-your-first-app) on how to add an app.
+Please have a look at the [getting started guide](/docs/getting-started/after-the-installation#adding-your-first-app) on how to add an app.
 
 ## General
 
 Here, you can configure:
 
 - what name should be displayed on the tile
-- the internal address *(see [glossary](../../getting-started/glossary))*
-- the external address *(see [glossary](../../getting-started/glossary))*
+- the internal address *(see [glossary](/docs/getting-started/glossary))*
+- the external address *(see [glossary](/docs/getting-started/glossary))*
 
 In most scenarios, you should set the internal IP address to the LAN address (this means your local IPv4 address).
 Homarr will use this IP to communicate with your app if needed.
@@ -60,7 +58,7 @@ You can set a message/description to be shown when hovering your mouse over the
 As mention earlier, you can configure apps on your board to communicate.
 This section configures whether you want to do this.
 
-This feature is explained in greater detail here: [configuring pings on your board](../../advanced/customizations/board-customization.mdx#pings).
+This feature is explained in greater detail here: [configuring pings on your board](/docs/advanced/customizations/board-customization.mdx#pings).
 
 <br/>
 

docs/getting-started/after-the-installation.mdx

@@ -45,7 +45,7 @@ Changes are only saved when you exit Edit Mode. If you leave the page **without
 ## Adding your first app
 In Homarr, apps are the key concept.
 An app is a tile on your board that links to an application.
-Apps may have an integration to integrate with your favourite applications (see [integrations](../management/integrations)).
+Apps may have an integration to integrate with your favourite applications (see [integrations](/docs/category/integrations)).
 
 Let's begin by adding your first app to Homarr. [Enter Edit Mode](#entering-edit-mode) and click on the Add a Tile button:
 
@@ -121,7 +121,7 @@ Wigets can be organized the same way as apps can be. Please note that some widge
 
 :::
 
-Integrations are configured using the "Integration" tab when Editing/Adding a widget. You can [choose from a variety of integrations](/docs/management/integrations/).
+Integrations are configured using the "Integration" tab when Editing/Adding a widget. You can [choose from a variety of integrations](/docs/category/integrations).
 
 ![](img/app-integration.webp)
 

docs/getting-started/installation.mdx

@@ -9,19 +9,19 @@ tags:
   - Helm
 ---
 
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 import Link from '@docusaurus/Link';
 import { IconDownload } from '@tabler/icons';
+import TabItem from '@theme/TabItem';
+import Tabs from '@theme/Tabs';
 
 We provide multiple installation methods. [Are you a newbie to Docker? We recommend Docker Compose for beginners](#-docker-compose).
-More experienced? Try out [Helm Charts](#installation-using-helm) or [TrueNas Scale](#-truenas).
+More experienced? Try out [Helm Charts](#helm-chart) or [TrueNas Scale](#-truenas).
 
 ## Docker
 ### 🐋 Docker Compose
 #### Prerequisites
 
-- A Linux or Windows based system that meets the [hardware prerequisites](./prerequisites#hardware) and [architecture prerequisites](./prerequisites#Architecture).
+- A Linux or Windows based system that meets the [hardware prerequisites](/docs/getting-started/#hardware) and [architecture prerequisites](/docs/getting-started/#architecture).
 - [Docker](https://docs.docker.com/get-docker/)
 - [Docker Compose](https://docs.docker.com/compose/install/) - *preinstalled on many systems nowadays*
 
@@ -80,17 +80,17 @@ To uninstall, navigate to the directory with the ``docker-compose.yaml`` located
 
 <br/>
 
-### 🐋 Docker - Not recommended
+### 🐋 Docker Standalone
 
 :::caution
 
-Docker is a not recommended installation method, because [Docker Compose](#docker-compose) is in many ways superior and easier to use for beginners.
+Docker is a not the recommended installation method, because [Docker Compose](#-docker-compose) is in many ways superior and easier to use for beginners. Continue along if you know what you're doing.
 
 :::
 
 #### Prerequisites
 
-- A Linux or Windows based system that meets the [hardware prerequisites](./prerequisites#hardware) and [architecture prerequisites](./prerequisites#Architecture).
+- A Linux or Windows based system that meets the [hardware prerequisites](/docs/getting-started/#hardware) and [architecture prerequisites](/docs/getting-started/#architecture).
 - [Docker](https://docs.docker.com/get-docker/)
 
 #### Installation
@@ -141,7 +141,7 @@ To update Homarr, you must remove your container first. Make sure that you've mo
 2. Pull the latest Homarr image ``docker pull ghcr.io/ajnart/homarr:latest``.
 3. Re-run the command you used to install Homarr.
 
-This process can get tideous, if you update frequently. Thus, we recommend [the installation using docker-compose](#-installation-using-docker-compose-or-portainer) for more experienced users.
+This process can get tideous, if you update frequently. Thus, we recommend [using docker-compose](#-docker-compose) 
 
 :::tip
 

docs/integrations/_category_.json

@@ -0,0 +1,10 @@
+{
+  "label": "Integrations",
+  "collapsed": true,
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "title": "Integrations",
+    "description": "Integration are a principal part of homarr, it's where you can connect your other apps to interact with them with widgets, Homarr currently integrates with the following types of applications:"
+  }
+}

docs/management/integrations/containers.mdx → docs/integrations/containers.mdx

@@ -1,5 +1,5 @@
 # 🐋 Containers
-## Docker
+## Managing your Docker containers within Homarr
 
 Homarr allows you to interact with Docker containers running on your system.
 

docs/integrations/hardware.mdx

@@ -0,0 +1,6 @@
+# 🖥️ Hardware
+
+## With dashdot, you can monitor the performance and used system resources of your machine.
+
+The Dash. integration can be used to monitor the performance and used system resources of your machine.
+Dash. will be used in the [Dash.](/docs/widgets/dashdot-widget)

docs/management/integrations/media-requester.mdx → docs/integrations/media-requester.mdx

@@ -3,7 +3,7 @@ import TabItem from '@theme/TabItem';
 
 # 📻 Media requesters
 
-The [Overseerr](https://overseerr.dev/) integration will enable you to request movies and series directly from your Homarr dashboard.
+The [Overseerr](https://overseerr.dev/) / Jellyseerr integration will enable you to request movies and series directly from your Homarr dashboard.
 
 ![](img/overseerr/search-select.webp)
 

docs/management/integrations/media-server.mdx → docs/integrations/media-server.mdx

@@ -11,7 +11,7 @@ We recommend creating a separate account just for Homarr. Only grant access to t
 
 
 ## Jellyfin (and Emby)
-The Jellyfin integration enables you to view the active sessions, using the [Media Server widget](../../dashboards/widgets/media-server), on your dashboard.
+The Jellyfin integration enables you to view the active sessions, using the [Media Server widget](/docs/widgets/media-server), on your dashboard.
 
 ::::info[Emby]
 
@@ -27,6 +27,8 @@ Although we do mention of this possible use, this is not an official implementat
 
 ::::
 
+The Jellyfin integration enables you to view the active sessions, using the [Media Server widget](/docs/widgets/media-server), on your dashboard.
+
 <details>
   <summary>
   Available configuration options
@@ -42,7 +44,7 @@ Although we do mention of this possible use, this is not an official implementat
 </details>
 
 ## Plex
-For a successful integration, remember that the internal address should not have a path, only the IP and the port (http://IP:port).
+For a successful integration, remember that the internal address should not have a path, only the IP and the port (``http://ip:port``).
 
 In this case it would mean to remove anything of the likes of "/web/index.html" from the link you would usually use.
 

docs/management/integrations/servarr.mdx → docs/integrations/servarr.mdx

@@ -4,7 +4,7 @@ Servarr, also known as the *-arr apps, help you to organize, aggregate, download
 
 ## Sonarr
 
-Alparr will integrate the shows of your [Sonarr](https://sonarr.tv/) calendars in the [Calendar Widget](/docs/dashboards/widgets/calendar-widget)
+Alparr will integrate the shows of your [Sonarr](https://sonarr.tv/) calendars in the [Calendar Widget](/docs/widgets/calendar-widget)
 
 <details>
   <summary>
@@ -21,7 +21,7 @@ Alparr will integrate the shows of your [Sonarr](https://sonarr.tv/) calendars i
 
 ## Radarr
 
-Homarr will integrate the shows of your [Radarr](https://radarr.video/) calendars in the [Calendar Widget](/docs/dashboards/widgets/calendar-widget)
+Homarr will integrate the shows of your [Radarr](https://radarr.video/) calendars in the [Calendar Widget](/docs/widgets/calendar-widget)
 
 <details>
   <summary>
@@ -38,7 +38,7 @@ Homarr will integrate the shows of your [Radarr](https://radarr.video/) calendar
 
 ## Lidarr
 
-Homarr will integrate the shows of your [Lidarr](https://lidarr.audio/) calendars in the [Calendar Widget](/docs/dashboards/widgets/calendar-widget)
+Homarr will integrate the shows of your [Lidarr](https://lidarr.audio/) calendars in the [Calendar Widget](/docs/widgets/calendar-widget)
 
 <details>
   <summary>
@@ -55,7 +55,7 @@ Homarr will integrate the shows of your [Lidarr](https://lidarr.audio/) calendar
 
 ## Readarr
 
-Homarr will integrate the shows of your [Readarr](https://readarr.com/) calendars in the [Calendar Widget](/docs/dashboards/widgets/calendar-widget)
+Homarr will integrate the shows of your [Readarr](https://readarr.com/) calendars in the [Calendar Widget](/docs/widgets/calendar-widget)
 
 <details>
   <summary>

docs/management/integrations/torrent.mdx → docs/integrations/torrent.mdx

@@ -6,8 +6,8 @@ You can use them to display your torrents directly on your dashboard and see if
 ## Deluge
 The Deluge integration is used by the following widgets:
 
-- [Torrent](/docs/dashboards/widgets/torrent-widget)
-- [Download Speed](/docs/dashboards/widgets/download-speed-widget)
+- [Torrent](/docs/widgets/torrent-widget)
+- [Download Speed](/docs/widgets/download-speed-widget)
 
 <details>
   <summary>
@@ -25,8 +25,8 @@ The Deluge integration is used by the following widgets:
 ## Transmission
 The Transmission integration is used by the following widgets:
 
-- [Torrent](/docs/dashboards/widgets/torrent-widget)
-- [Download Speed](/docs/dashboards/widgets/download-speed-widget)
+- [Torrent](/docs/widgets/torrent-widget)
+- [Download Speed](/docs/widgets/download-speed-widget)
 
 <details>
   <summary>
@@ -45,8 +45,8 @@ The Transmission integration is used by the following widgets:
 ## qBittorrent Integration
 The qBittorrent integration is used by the following widgets:
 
-- [Torrent](/docs/dashboards/widgets/torrent-widget)
-- [Download Speed](/docs/dashboards/widgets/download-speed-widget)
+- [Torrent](/docs/widgets/torrent-widget)
+- [Download Speed](/docs/widgets/download-speed-widget)
 
 <details>
   <summary>

docs/management/integrations/usenet.mdx → docs/integrations/usenet.mdx

@@ -4,7 +4,7 @@ Usenet clients are an alternative to Torrent clients and enable you to download
 ## SABnzbd
 
 The [SABnzbd](https://sabnzbd.org/) integration directly communicates with your download client and enables you to view and control your downloads directly from Homarr.
-You can use this integration from the [Usenet Widget](/docs/dashboards/widgets/usenet-widget).
+You can use this integration from the [Usenet Widget](/docs/widgets/usenet-widget).
 
 <details>
   <summary>
@@ -22,7 +22,7 @@ You can use this integration from the [Usenet Widget](/docs/dashboards/widgets/u
 ## NZBGet
 
 The [NZBGet](https://nzbget.net/) integration directly communicates with your download client and enables you to view and control your downloads directly from Homarr.
-You can use this integration from the [Usenet Widget](/docs/dashboards/widgets/usenet-widget).
+You can use this integration from the [Usenet Widget](/docs/widgets/usenet-widget).
 
 <details>
   <summary>

docs/management/_category_.json

@@ -0,0 +1,10 @@
+{
+  "label": "Managment",
+  "collapsed": true,
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "title": "Managment pages",
+    "description": "Management pages enable you to control and adjust resources on your Homarr servers."
+  }
+}