From 8691ae3af32cec9f348e85cfeda769770c72dc29 Mon Sep 17 00:00:00 2001 From: Thomas Camlong Date: Tue, 5 Mar 2024 20:17:03 +0100 Subject: [PATCH] refactor: rework documentation (#38) Co-authored-by: Manuel <30572287+manuel-rw@users.noreply.github.com> --- README.md | 6 +- blog/2023-01-11-version0.11.md | 2 +- docs/advanced/_category_.json | 9 +++ .../configuration/environment-variables.mdx | 2 +- docs/advanced/sso.mdx | 2 +- docs/community/_category_.json | 9 +++ docs/dashboards/apps/_category_.json | 4 -- .../widgets/indexer-manager/index.mdx | 2 +- docs/getting-started/_category_.json | 9 +++ .../adding-an-app.mdx} | 14 ++-- .../after-the-installation.mdx | 4 +- .../img/app-general-tab.png | Bin .../img/app-no-title.webp | Bin .../img/app-title-bottom.webp | Bin .../img/app-title-hover.webp | Bin .../img/app-title-left.webp | Bin .../img/app-title-right.webp | Bin .../img/app-title-top.webp | Bin .../img/appearance-tab.webp | Bin .../img/behavior-tab.webp | Bin .../img/description-hover-example.webp | Bin .../{prerequisites.mdx => index.mdx} | 0 docs/getting-started/installation.mdx | 16 ++--- docs/integrations/_category_.json | 10 +++ .../integrations/containers.mdx | 2 +- docs/{management => }/integrations/dns.mdx | 0 docs/integrations/hardware.mdx | 6 ++ .../img/container-and-image-search.png | Bin .../integrations/img/container-states.png | Bin .../integrations/img/docker-core-features.png | Bin .../integrations/img/exposed-ports.png | Bin .../img/overseerr/add-application.webp | Bin .../img/overseerr/search-select.webp | Bin .../img/overseerr/search-show.webp | Bin .../widget-overseerr-season-select.webp | Bin .../integrations/media-requester.mdx | 2 +- .../integrations/media-server.mdx | 6 +- .../{management => }/integrations/servarr.mdx | 8 +-- .../{management => }/integrations/torrent.mdx | 12 ++-- docs/{management => }/integrations/usenet.mdx | 4 +- docs/management/_category_.json | 10 +++ .../{resources => }/boards/index.mdx | 0 docs/management/integrations/_category_.json | 3 - docs/management/integrations/hardware.mdx | 6 -- docs/management/integrations/index.mdx | 41 ----------- .../integrations/indexer-manager.mdx | 19 ----- docs/management/resources/_category_.json | 3 - docs/management/resources/index.mdx | 11 --- .../users/img/img-copy-invite-link.png | Bin .../users/img/img-manage-navbar.png | Bin .../users/img/img-navigate-manage.png | Bin .../{resources => }/users/index.mdx | 2 +- docs/{dashboards => }/widgets/_category_.json | 2 +- .../widgets/bookmarks/index.mdx | 0 .../widgets/bookmarks/widget-auto-grid.webp | Bin .../bookmarks/widget-configuration.webp | Bin .../widgets/bookmarks/widget-example.webp | Bin .../widgets/bookmarks/widget-horizontal.webp | Bin .../widgets/calendar-widget.mdx | 4 +- .../{dashboards => }/widgets/clock-widget.mdx | 0 .../widgets/dashdot-widget.mdx | 0 .../controls-widget-badge-highlight.webp | Bin .../dns-hole/controls-widget-buttonless.webp | Bin .../controls-widget-configuration.webp | Bin .../widgets/dns-hole/controls-widget.webp | Bin .../widgets/dns-hole/get-api-token.webp | Bin .../widgets/dns-hole/index.mdx | 0 .../dns-hole/summary-widget-colored.webp | Bin .../summary-widget-configuration.webp | Bin .../dns-hole/summary-widget-horizontal.webp | Bin .../dns-hole/summary-widget-vertical.webp | Bin .../widgets/dns-hole/summary-widget.webp | Bin .../widgets/download-speed-widget.mdx | 4 +- ...6-ac776c51-0333-4cda-84a5-07a2e660fcc1.png | Bin .../home-assistant/img/copy-entity-id.png | Bin .../home-assistant/img/hass-token-copy.png | Bin .../widgets/home-assistant/index.mdx | 2 +- .../{dashboards => }/widgets/iframe/index.mdx | 0 .../widgets/iframe/widget.webp | Bin .../widgets/img/add-widget.webp | Bin .../calendar/sonarr-configure-credentials.gif | Bin .../widget-calendar-configuration.webp | Bin .../calendar/widget-calendar-dark-mode.webp | Bin .../widget-calendar-day-information.webp | Bin .../calendar/widget-calendar-indicators.webp | Bin ...get-calendar-integration-api-key-link.webp | Bin ...dar-integration-lidarr-missing-poster.webp | Bin ...t-calendar-integration-sonarr-example.webp | Bin ...et-calendar-integration-sonarr-poster.webp | Bin .../calendar/widget-calendar-light-mode.webp | Bin .../img/calendar/widget-calendar-show.gif | Bin .../widgets/img/choose-widget-in-modal.webp | Bin .../widgets/img/choose-widgets-in-modal.webp | Bin ...t-clock-configuration-date-formatting.webp | Bin .../img/clock/widget-clock-configuration.webp | Bin .../img/clock/widget-clock-dark-mode.webp | Bin .../img/clock/widget-clock-light-mode.webp | Bin .../dashDot/widget-dashdot-configuration.webp | Bin .../dashDot/widget-dashdot-light-mode.webp | Bin .../img/media-server/media-server-widget.webp | Bin .../img/media-server/stats-for-nerds.webp | Bin .../widget-download-speed-dark.webp | Bin .../networkSpeed/widget-download-speed.webp | Bin .../widgets/img/rss/rss-widget-config.webp | Bin .../widgets/img/rss/rss-widget.webp | Bin .../widget-torrent-app-type-example.webp | Bin .../torrent/widget-torrent-configuration.webp | Bin .../widgets/img/torrent/widget-torrent.webp | Bin .../img/usenet/widget-usenet-dark.webp | Bin .../widgets/img/usenet/widget-usenet.webp | Bin .../weather/widget-weather-configuration.webp | Bin .../img/weather/widget-weather-dark-mode.webp | Bin .../weather/widget-weather-light-mode.webp | Bin .../widgets/media-requests/index.mdx | 2 +- .../media-requests/widget-configuration.webp | Bin .../media-requests/widget-statistics.webp | Bin .../widgets/media-requests/widget.webp | Bin .../{dashboards => }/widgets/media-server.mdx | 0 .../widgets/notebook/index.mdx | 0 .../notebook/notebook-enter-editing.webp | Bin .../notebook/notebook-exit-editing.webp | Bin .../notebook/notebook-image-modal.webp | Bin .../widgets/notebook/notebook-link-modal.webp | Bin .../notebook/notebook-table-modal.webp | Bin .../notebook/notebook-toolbar-lists.webp | Bin .../notebook/notebook-toolbar-table.webp | Bin .../widgets/notebook/notebook-toolbar.webp | Bin .../notebook/widget-configuration.webp | Bin .../widgets/notebook/widget.webp | Bin docs/{dashboards => }/widgets/rss-widget.mdx | 0 .../widgets/torrent-widget.mdx | 2 +- .../widgets/usenet-widget.mdx | 4 +- docs/{dashboards => }/widgets/video/index.mdx | 0 .../widgets/video/widget.webp | Bin .../widgets/weather-widget.mdx | 0 docusaurus.config.ts | 66 ++++++------------ sidebars.js | 4 +- src/components/pages/home/hero/hero.tsx | 9 ++- 138 files changed, 131 insertions(+), 192 deletions(-) create mode 100644 docs/advanced/_category_.json create mode 100644 docs/community/_category_.json delete mode 100644 docs/dashboards/apps/_category_.json create mode 100644 docs/getting-started/_category_.json rename docs/{dashboards/apps/index.md => getting-started/adding-an-app.mdx} (88%) rename docs/{dashboards/apps => getting-started}/img/app-general-tab.png (100%) rename docs/{dashboards/apps => getting-started}/img/app-no-title.webp (100%) rename docs/{dashboards/apps => getting-started}/img/app-title-bottom.webp (100%) rename docs/{dashboards/apps => getting-started}/img/app-title-hover.webp (100%) rename docs/{dashboards/apps => getting-started}/img/app-title-left.webp (100%) rename docs/{dashboards/apps => getting-started}/img/app-title-right.webp (100%) rename docs/{dashboards/apps => getting-started}/img/app-title-top.webp (100%) rename docs/{dashboards/apps => getting-started}/img/appearance-tab.webp (100%) rename docs/{dashboards/apps => getting-started}/img/behavior-tab.webp (100%) rename docs/{dashboards/apps => getting-started}/img/description-hover-example.webp (100%) rename docs/getting-started/{prerequisites.mdx => index.mdx} (100%) create mode 100644 docs/integrations/_category_.json rename docs/{management => }/integrations/containers.mdx (95%) rename docs/{management => }/integrations/dns.mdx (100%) create mode 100644 docs/integrations/hardware.mdx rename docs/{management => }/integrations/img/container-and-image-search.png (100%) rename docs/{management => }/integrations/img/container-states.png (100%) rename docs/{management => }/integrations/img/docker-core-features.png (100%) rename docs/{management => }/integrations/img/exposed-ports.png (100%) rename docs/{management => }/integrations/img/overseerr/add-application.webp (100%) rename docs/{management => }/integrations/img/overseerr/search-select.webp (100%) rename docs/{management => }/integrations/img/overseerr/search-show.webp (100%) rename docs/{management => }/integrations/img/overseerr/widget-overseerr-season-select.webp (100%) rename docs/{management => }/integrations/media-requester.mdx (96%) rename docs/{management => }/integrations/media-server.mdx (84%) rename docs/{management => }/integrations/servarr.mdx (80%) rename docs/{management => }/integrations/torrent.mdx (78%) rename docs/{management => }/integrations/usenet.mdx (84%) create mode 100644 docs/management/_category_.json rename docs/management/{resources => }/boards/index.mdx (100%) delete mode 100644 docs/management/integrations/_category_.json delete mode 100644 docs/management/integrations/hardware.mdx delete mode 100644 docs/management/integrations/index.mdx delete mode 100644 docs/management/integrations/indexer-manager.mdx delete mode 100644 docs/management/resources/_category_.json delete mode 100644 docs/management/resources/index.mdx rename docs/management/{resources => }/users/img/img-copy-invite-link.png (100%) rename docs/management/{resources => }/users/img/img-manage-navbar.png (100%) rename docs/management/{resources => }/users/img/img-navigate-manage.png (100%) rename docs/management/{resources => }/users/index.mdx (98%) rename docs/{dashboards => }/widgets/_category_.json (93%) rename docs/{dashboards => }/widgets/bookmarks/index.mdx (100%) rename docs/{dashboards => }/widgets/bookmarks/widget-auto-grid.webp (100%) rename docs/{dashboards => }/widgets/bookmarks/widget-configuration.webp (100%) rename docs/{dashboards => }/widgets/bookmarks/widget-example.webp (100%) rename docs/{dashboards => }/widgets/bookmarks/widget-horizontal.webp (100%) rename docs/{dashboards => }/widgets/calendar-widget.mdx (91%) rename docs/{dashboards => }/widgets/clock-widget.mdx (100%) rename docs/{dashboards => }/widgets/dashdot-widget.mdx (100%) rename docs/{dashboards => }/widgets/dns-hole/controls-widget-badge-highlight.webp (100%) rename docs/{dashboards => }/widgets/dns-hole/controls-widget-buttonless.webp (100%) rename docs/{dashboards => }/widgets/dns-hole/controls-widget-configuration.webp (100%) rename docs/{dashboards => }/widgets/dns-hole/controls-widget.webp (100%) rename docs/{dashboards => }/widgets/dns-hole/get-api-token.webp (100%) rename docs/{dashboards => }/widgets/dns-hole/index.mdx (100%) rename docs/{dashboards => }/widgets/dns-hole/summary-widget-colored.webp (100%) rename docs/{dashboards => }/widgets/dns-hole/summary-widget-configuration.webp (100%) rename docs/{dashboards => }/widgets/dns-hole/summary-widget-horizontal.webp (100%) rename docs/{dashboards => }/widgets/dns-hole/summary-widget-vertical.webp (100%) rename docs/{dashboards => }/widgets/dns-hole/summary-widget.webp (100%) rename docs/{dashboards => }/widgets/download-speed-widget.mdx (73%) rename docs/{dashboards => }/widgets/home-assistant/img/283935576-ac776c51-0333-4cda-84a5-07a2e660fcc1.png (100%) rename docs/{dashboards => }/widgets/home-assistant/img/copy-entity-id.png (100%) rename docs/{dashboards => }/widgets/home-assistant/img/hass-token-copy.png (100%) rename docs/{dashboards => }/widgets/home-assistant/index.mdx (97%) rename docs/{dashboards => }/widgets/iframe/index.mdx (100%) rename docs/{dashboards => }/widgets/iframe/widget.webp (100%) rename docs/{dashboards => }/widgets/img/add-widget.webp (100%) rename docs/{dashboards => }/widgets/img/calendar/sonarr-configure-credentials.gif (100%) rename docs/{dashboards => }/widgets/img/calendar/widget-calendar-configuration.webp (100%) rename docs/{dashboards => }/widgets/img/calendar/widget-calendar-dark-mode.webp (100%) rename docs/{dashboards => }/widgets/img/calendar/widget-calendar-day-information.webp (100%) rename docs/{dashboards => }/widgets/img/calendar/widget-calendar-indicators.webp (100%) rename docs/{dashboards => }/widgets/img/calendar/widget-calendar-integration-api-key-link.webp (100%) rename docs/{dashboards => }/widgets/img/calendar/widget-calendar-integration-lidarr-missing-poster.webp (100%) rename docs/{dashboards => }/widgets/img/calendar/widget-calendar-integration-sonarr-example.webp (100%) rename docs/{dashboards => }/widgets/img/calendar/widget-calendar-integration-sonarr-poster.webp (100%) rename docs/{dashboards => }/widgets/img/calendar/widget-calendar-light-mode.webp (100%) rename docs/{dashboards => }/widgets/img/calendar/widget-calendar-show.gif (100%) rename docs/{dashboards => }/widgets/img/choose-widget-in-modal.webp (100%) rename docs/{dashboards => }/widgets/img/choose-widgets-in-modal.webp (100%) rename docs/{dashboards => }/widgets/img/clock/widget-clock-configuration-date-formatting.webp (100%) rename docs/{dashboards => }/widgets/img/clock/widget-clock-configuration.webp (100%) rename docs/{dashboards => }/widgets/img/clock/widget-clock-dark-mode.webp (100%) rename docs/{dashboards => }/widgets/img/clock/widget-clock-light-mode.webp (100%) rename docs/{dashboards => }/widgets/img/dashDot/widget-dashdot-configuration.webp (100%) rename docs/{dashboards => }/widgets/img/dashDot/widget-dashdot-light-mode.webp (100%) rename docs/{dashboards => }/widgets/img/media-server/media-server-widget.webp (100%) rename docs/{dashboards => }/widgets/img/media-server/stats-for-nerds.webp (100%) rename docs/{dashboards => }/widgets/img/networkSpeed/widget-download-speed-dark.webp (100%) rename docs/{dashboards => }/widgets/img/networkSpeed/widget-download-speed.webp (100%) rename docs/{dashboards => }/widgets/img/rss/rss-widget-config.webp (100%) rename docs/{dashboards => }/widgets/img/rss/rss-widget.webp (100%) rename docs/{dashboards => }/widgets/img/torrent/widget-torrent-app-type-example.webp (100%) rename docs/{dashboards => }/widgets/img/torrent/widget-torrent-configuration.webp (100%) rename docs/{dashboards => }/widgets/img/torrent/widget-torrent.webp (100%) rename docs/{dashboards => }/widgets/img/usenet/widget-usenet-dark.webp (100%) rename docs/{dashboards => }/widgets/img/usenet/widget-usenet.webp (100%) rename docs/{dashboards => }/widgets/img/weather/widget-weather-configuration.webp (100%) rename docs/{dashboards => }/widgets/img/weather/widget-weather-dark-mode.webp (100%) rename docs/{dashboards => }/widgets/img/weather/widget-weather-light-mode.webp (100%) rename docs/{dashboards => }/widgets/media-requests/index.mdx (91%) rename docs/{dashboards => }/widgets/media-requests/widget-configuration.webp (100%) rename docs/{dashboards => }/widgets/media-requests/widget-statistics.webp (100%) rename docs/{dashboards => }/widgets/media-requests/widget.webp (100%) rename docs/{dashboards => }/widgets/media-server.mdx (100%) rename docs/{dashboards => }/widgets/notebook/index.mdx (100%) rename docs/{dashboards => }/widgets/notebook/notebook-enter-editing.webp (100%) rename docs/{dashboards => }/widgets/notebook/notebook-exit-editing.webp (100%) rename docs/{dashboards => }/widgets/notebook/notebook-image-modal.webp (100%) rename docs/{dashboards => }/widgets/notebook/notebook-link-modal.webp (100%) rename docs/{dashboards => }/widgets/notebook/notebook-table-modal.webp (100%) rename docs/{dashboards => }/widgets/notebook/notebook-toolbar-lists.webp (100%) rename docs/{dashboards => }/widgets/notebook/notebook-toolbar-table.webp (100%) rename docs/{dashboards => }/widgets/notebook/notebook-toolbar.webp (100%) rename docs/{dashboards => }/widgets/notebook/widget-configuration.webp (100%) rename docs/{dashboards => }/widgets/notebook/widget.webp (100%) rename docs/{dashboards => }/widgets/rss-widget.mdx (100%) rename docs/{dashboards => }/widgets/torrent-widget.mdx (87%) rename docs/{dashboards => }/widgets/usenet-widget.mdx (71%) rename docs/{dashboards => }/widgets/video/index.mdx (100%) rename docs/{dashboards => }/widgets/video/widget.webp (100%) rename docs/{dashboards => }/widgets/weather-widget.mdx (100%) diff --git a/README.md b/README.md index 1b64d608..7ab60430 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,13 @@ 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. @@ -19,7 +19,7 @@ This command starts a local development server and opens up a browser window. Mo ### Build ``` -$ yarn build +$ pnpm build ``` This command generates static content into the `build` directory and can be served using any static contents hosting app. diff --git a/blog/2023-01-11-version0.11.md b/blog/2023-01-11-version0.11.md index 4343e2fe..05d73aaf 100644 --- a/blog/2023-01-11-version0.11.md +++ b/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 diff --git a/docs/advanced/_category_.json b/docs/advanced/_category_.json new file mode 100644 index 00000000..6fc6a617 --- /dev/null +++ b/docs/advanced/_category_.json @@ -0,0 +1,9 @@ +{ + "label": "Advanced", + "collapsed": true, + "position": 4, + "link": { + "type": "generated-index", + "title": "Advanced Concepts or features" + } +} diff --git a/docs/advanced/configuration/environment-variables.mdx b/docs/advanced/configuration/environment-variables.mdx index 0eedab0c..fae608d4 100644 --- a/docs/advanced/configuration/environment-variables.mdx +++ b/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 diff --git a/docs/advanced/sso.mdx b/docs/advanced/sso.mdx index 2c9e8818..e0773ab4 100644 --- a/docs/advanced/sso.mdx +++ b/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)) diff --git a/docs/community/_category_.json b/docs/community/_category_.json new file mode 100644 index 00000000..5134fc58 --- /dev/null +++ b/docs/community/_category_.json @@ -0,0 +1,9 @@ +{ + "label": "More", + "position": 5, + "collapsed": true, + "link": { + "type": "generated-index", + "title": "More" + } +} diff --git a/docs/dashboards/apps/_category_.json b/docs/dashboards/apps/_category_.json deleted file mode 100644 index 81492b2e..00000000 --- a/docs/dashboards/apps/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Apps", - "position": 2 -} diff --git a/docs/dashboards/widgets/indexer-manager/index.mdx b/docs/dashboards/widgets/indexer-manager/index.mdx index 73d5da7b..2c760a36 100644 --- a/docs/dashboards/widgets/indexer-manager/index.mdx +++ b/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 diff --git a/docs/getting-started/_category_.json b/docs/getting-started/_category_.json new file mode 100644 index 00000000..28623c90 --- /dev/null +++ b/docs/getting-started/_category_.json @@ -0,0 +1,9 @@ +{ + "label": "Getting started", + "position": 1, + "collapsed": false, + "link": { + "type": "generated-index", + "title": "Getting started" + } +} diff --git a/docs/dashboards/apps/index.md b/docs/getting-started/adding-an-app.mdx similarity index 88% rename from docs/dashboards/apps/index.md rename to docs/getting-started/adding-an-app.mdx index 23b6db71..2b08fa95 100644 --- a/docs/dashboards/apps/index.md +++ b/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).
diff --git a/docs/getting-started/after-the-installation.mdx b/docs/getting-started/after-the-installation.mdx index dd842095..cc842206 100644 --- a/docs/getting-started/after-the-installation.mdx +++ b/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) diff --git a/docs/dashboards/apps/img/app-general-tab.png b/docs/getting-started/img/app-general-tab.png similarity index 100% rename from docs/dashboards/apps/img/app-general-tab.png rename to docs/getting-started/img/app-general-tab.png diff --git a/docs/dashboards/apps/img/app-no-title.webp b/docs/getting-started/img/app-no-title.webp similarity index 100% rename from docs/dashboards/apps/img/app-no-title.webp rename to docs/getting-started/img/app-no-title.webp diff --git a/docs/dashboards/apps/img/app-title-bottom.webp b/docs/getting-started/img/app-title-bottom.webp similarity index 100% rename from docs/dashboards/apps/img/app-title-bottom.webp rename to docs/getting-started/img/app-title-bottom.webp diff --git a/docs/dashboards/apps/img/app-title-hover.webp b/docs/getting-started/img/app-title-hover.webp similarity index 100% rename from docs/dashboards/apps/img/app-title-hover.webp rename to docs/getting-started/img/app-title-hover.webp diff --git a/docs/dashboards/apps/img/app-title-left.webp b/docs/getting-started/img/app-title-left.webp similarity index 100% rename from docs/dashboards/apps/img/app-title-left.webp rename to docs/getting-started/img/app-title-left.webp diff --git a/docs/dashboards/apps/img/app-title-right.webp b/docs/getting-started/img/app-title-right.webp similarity index 100% rename from docs/dashboards/apps/img/app-title-right.webp rename to docs/getting-started/img/app-title-right.webp diff --git a/docs/dashboards/apps/img/app-title-top.webp b/docs/getting-started/img/app-title-top.webp similarity index 100% rename from docs/dashboards/apps/img/app-title-top.webp rename to docs/getting-started/img/app-title-top.webp diff --git a/docs/dashboards/apps/img/appearance-tab.webp b/docs/getting-started/img/appearance-tab.webp similarity index 100% rename from docs/dashboards/apps/img/appearance-tab.webp rename to docs/getting-started/img/appearance-tab.webp diff --git a/docs/dashboards/apps/img/behavior-tab.webp b/docs/getting-started/img/behavior-tab.webp similarity index 100% rename from docs/dashboards/apps/img/behavior-tab.webp rename to docs/getting-started/img/behavior-tab.webp diff --git a/docs/dashboards/apps/img/description-hover-example.webp b/docs/getting-started/img/description-hover-example.webp similarity index 100% rename from docs/dashboards/apps/img/description-hover-example.webp rename to docs/getting-started/img/description-hover-example.webp diff --git a/docs/getting-started/prerequisites.mdx b/docs/getting-started/index.mdx similarity index 100% rename from docs/getting-started/prerequisites.mdx rename to docs/getting-started/index.mdx diff --git a/docs/getting-started/installation.mdx b/docs/getting-started/installation.mdx index 06f2782f..e1244a46 100644 --- a/docs/getting-started/installation.mdx +++ b/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
-### 🐋 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 diff --git a/docs/integrations/_category_.json b/docs/integrations/_category_.json new file mode 100644 index 00000000..33f3c40e --- /dev/null +++ b/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:" + } +} diff --git a/docs/management/integrations/containers.mdx b/docs/integrations/containers.mdx similarity index 95% rename from docs/management/integrations/containers.mdx rename to docs/integrations/containers.mdx index 1ac42181..2ce30b1d 100644 --- a/docs/management/integrations/containers.mdx +++ b/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. diff --git a/docs/management/integrations/dns.mdx b/docs/integrations/dns.mdx similarity index 100% rename from docs/management/integrations/dns.mdx rename to docs/integrations/dns.mdx diff --git a/docs/integrations/hardware.mdx b/docs/integrations/hardware.mdx new file mode 100644 index 00000000..82e81576 --- /dev/null +++ b/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) \ No newline at end of file diff --git a/docs/management/integrations/img/container-and-image-search.png b/docs/integrations/img/container-and-image-search.png similarity index 100% rename from docs/management/integrations/img/container-and-image-search.png rename to docs/integrations/img/container-and-image-search.png diff --git a/docs/management/integrations/img/container-states.png b/docs/integrations/img/container-states.png similarity index 100% rename from docs/management/integrations/img/container-states.png rename to docs/integrations/img/container-states.png diff --git a/docs/management/integrations/img/docker-core-features.png b/docs/integrations/img/docker-core-features.png similarity index 100% rename from docs/management/integrations/img/docker-core-features.png rename to docs/integrations/img/docker-core-features.png diff --git a/docs/management/integrations/img/exposed-ports.png b/docs/integrations/img/exposed-ports.png similarity index 100% rename from docs/management/integrations/img/exposed-ports.png rename to docs/integrations/img/exposed-ports.png diff --git a/docs/management/integrations/img/overseerr/add-application.webp b/docs/integrations/img/overseerr/add-application.webp similarity index 100% rename from docs/management/integrations/img/overseerr/add-application.webp rename to docs/integrations/img/overseerr/add-application.webp diff --git a/docs/management/integrations/img/overseerr/search-select.webp b/docs/integrations/img/overseerr/search-select.webp similarity index 100% rename from docs/management/integrations/img/overseerr/search-select.webp rename to docs/integrations/img/overseerr/search-select.webp diff --git a/docs/management/integrations/img/overseerr/search-show.webp b/docs/integrations/img/overseerr/search-show.webp similarity index 100% rename from docs/management/integrations/img/overseerr/search-show.webp rename to docs/integrations/img/overseerr/search-show.webp diff --git a/docs/management/integrations/img/overseerr/widget-overseerr-season-select.webp b/docs/integrations/img/overseerr/widget-overseerr-season-select.webp similarity index 100% rename from docs/management/integrations/img/overseerr/widget-overseerr-season-select.webp rename to docs/integrations/img/overseerr/widget-overseerr-season-select.webp diff --git a/docs/management/integrations/media-requester.mdx b/docs/integrations/media-requester.mdx similarity index 96% rename from docs/management/integrations/media-requester.mdx rename to docs/integrations/media-requester.mdx index 92b078ad..25a7bd9a 100644 --- a/docs/management/integrations/media-requester.mdx +++ b/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) diff --git a/docs/management/integrations/media-server.mdx b/docs/integrations/media-server.mdx similarity index 84% rename from docs/management/integrations/media-server.mdx rename to docs/integrations/media-server.mdx index 0892d724..3dc8ab75 100644 --- a/docs/management/integrations/media-server.mdx +++ b/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. +
Available configuration options @@ -42,7 +44,7 @@ Although we do mention of this possible use, this is not an official implementat
## 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. diff --git a/docs/management/integrations/servarr.mdx b/docs/integrations/servarr.mdx similarity index 80% rename from docs/management/integrations/servarr.mdx rename to docs/integrations/servarr.mdx index 217e78a6..46d0406e 100644 --- a/docs/management/integrations/servarr.mdx +++ b/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)
@@ -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)
@@ -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)
@@ -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)
diff --git a/docs/management/integrations/torrent.mdx b/docs/integrations/torrent.mdx similarity index 78% rename from docs/management/integrations/torrent.mdx rename to docs/integrations/torrent.mdx index b0881953..6c92c370 100644 --- a/docs/management/integrations/torrent.mdx +++ b/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)
@@ -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)
@@ -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)
diff --git a/docs/management/integrations/usenet.mdx b/docs/integrations/usenet.mdx similarity index 84% rename from docs/management/integrations/usenet.mdx rename to docs/integrations/usenet.mdx index c043d01d..6806265d 100644 --- a/docs/management/integrations/usenet.mdx +++ b/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).
@@ -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).
diff --git a/docs/management/_category_.json b/docs/management/_category_.json new file mode 100644 index 00000000..0d955874 --- /dev/null +++ b/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." + } +} diff --git a/docs/management/resources/boards/index.mdx b/docs/management/boards/index.mdx similarity index 100% rename from docs/management/resources/boards/index.mdx rename to docs/management/boards/index.mdx diff --git a/docs/management/integrations/_category_.json b/docs/management/integrations/_category_.json deleted file mode 100644 index c4595acf..00000000 --- a/docs/management/integrations/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "collapsed": "false" -} diff --git a/docs/management/integrations/hardware.mdx b/docs/management/integrations/hardware.mdx deleted file mode 100644 index 9e0eb0fe..00000000 --- a/docs/management/integrations/hardware.mdx +++ /dev/null @@ -1,6 +0,0 @@ -# 🖥️ Hardware - -## Dash. - -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/dashboards/widgets/dashdot-widget) \ No newline at end of file diff --git a/docs/management/integrations/index.mdx b/docs/management/integrations/index.mdx deleted file mode 100644 index 3ca9c103..00000000 --- a/docs/management/integrations/index.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Integrations -description: Homarr has a built-in collection of widgets and integrations that connect to your applications and enable you to control them directly from your dashboards ---- - - -Homarr currently integrates with the following applications: - -### 📥 Torrent clients -- [Deluge](torrent#deluge) -- [Transmission](torrent#transmission) -- [qBittorent](torrent#qbittorrent) - -### 📥 Usenet clients -- [SABnzbd](usenet#sabnzbd) -- [NZBGet](usenet#nzbget) - -### 📺 Media servers -- [Plex](media-server#plex) -- [Jellyfin (and Emby)](media-server#jellyfin-and-emby) - -### 📚 Media collection managers -- [Sonarr](servarr#sonarr) -- [Radarr](servarr#radarr) -- [Lidarr](servarr#lidarr) -- [Readarr](servarr#readarr) - -### 🎞️ Media request managers -- [Overseerr](media-requester/) -- [Jellyseerr](media-requester/) - -### 🚫 DNS ad-blockers -- [Pihole](dns#pihole) -- [AdGuard Home](dns#adguard-home) - -### 🗂️ Indexer Manager -- [Prowlarr](indexer-manager#prowlarr) - -### ➕ Other integrations -- [🔌 Dash.](hardware#dash) -- [🐳 Docker](containers#docker) \ No newline at end of file diff --git a/docs/management/integrations/indexer-manager.mdx b/docs/management/integrations/indexer-manager.mdx deleted file mode 100644 index d0b82b5c..00000000 --- a/docs/management/integrations/indexer-manager.mdx +++ /dev/null @@ -1,19 +0,0 @@ -# 🗂️ Indexer Manager - -Homarr can integrate with your Indexr Manager, which allows you to monitor the indexers status and make test for all. - -## Prowlarr -The Prowlarr integration enables you to view the indexers status, using the [Indexer Manager widget](../../dashboards/widgets/indexer-manager) - -
- - Available configuration options - -
- -| Field | Type | Description | -| -------- | ------- | ----------- | -| API Key | Private | Used for authentication | - -
-
\ No newline at end of file diff --git a/docs/management/resources/_category_.json b/docs/management/resources/_category_.json deleted file mode 100644 index c4595acf..00000000 --- a/docs/management/resources/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "collapsed": "false" -} diff --git a/docs/management/resources/index.mdx b/docs/management/resources/index.mdx deleted file mode 100644 index af4c4f6c..00000000 --- a/docs/management/resources/index.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -sidebar_position: 0 -title: Management Pages ---- - -# About the management pages - -The management pages enable you to control and adjust resources on your Homarr server. -Each user on the instance has access to these pages, but some of them require the user to be administrators. - - diff --git a/docs/management/resources/users/img/img-copy-invite-link.png b/docs/management/users/img/img-copy-invite-link.png similarity index 100% rename from docs/management/resources/users/img/img-copy-invite-link.png rename to docs/management/users/img/img-copy-invite-link.png diff --git a/docs/management/resources/users/img/img-manage-navbar.png b/docs/management/users/img/img-manage-navbar.png similarity index 100% rename from docs/management/resources/users/img/img-manage-navbar.png rename to docs/management/users/img/img-manage-navbar.png diff --git a/docs/management/resources/users/img/img-navigate-manage.png b/docs/management/users/img/img-navigate-manage.png similarity index 100% rename from docs/management/resources/users/img/img-navigate-manage.png rename to docs/management/users/img/img-navigate-manage.png diff --git a/docs/management/resources/users/index.mdx b/docs/management/users/index.mdx similarity index 98% rename from docs/management/resources/users/index.mdx rename to docs/management/users/index.mdx index 738397f0..99acd09c 100644 --- a/docs/management/resources/users/index.mdx +++ b/docs/management/users/index.mdx @@ -19,7 +19,7 @@ User management will only be available to the Owner and Admins. Normal users wil :::tip -Homarr supports [single sign on for easier and seamless authentication](../../../advanced/sso) (eg. Authelia). +Homarr supports [single sign on for easier and seamless authentication](/docs/advanced/sso) (eg. Authelia). ::: diff --git a/docs/dashboards/widgets/_category_.json b/docs/widgets/_category_.json similarity index 93% rename from docs/dashboards/widgets/_category_.json rename to docs/widgets/_category_.json index 3a97f462..3df2005a 100644 --- a/docs/dashboards/widgets/_category_.json +++ b/docs/widgets/_category_.json @@ -1,7 +1,7 @@ { "label": "Widgets", "position": 3, - "collapsed": false, + "collapsed": true, "link": { "type": "generated-index", "title": "Widgets", diff --git a/docs/dashboards/widgets/bookmarks/index.mdx b/docs/widgets/bookmarks/index.mdx similarity index 100% rename from docs/dashboards/widgets/bookmarks/index.mdx rename to docs/widgets/bookmarks/index.mdx diff --git a/docs/dashboards/widgets/bookmarks/widget-auto-grid.webp b/docs/widgets/bookmarks/widget-auto-grid.webp similarity index 100% rename from docs/dashboards/widgets/bookmarks/widget-auto-grid.webp rename to docs/widgets/bookmarks/widget-auto-grid.webp diff --git a/docs/dashboards/widgets/bookmarks/widget-configuration.webp b/docs/widgets/bookmarks/widget-configuration.webp similarity index 100% rename from docs/dashboards/widgets/bookmarks/widget-configuration.webp rename to docs/widgets/bookmarks/widget-configuration.webp diff --git a/docs/dashboards/widgets/bookmarks/widget-example.webp b/docs/widgets/bookmarks/widget-example.webp similarity index 100% rename from docs/dashboards/widgets/bookmarks/widget-example.webp rename to docs/widgets/bookmarks/widget-example.webp diff --git a/docs/dashboards/widgets/bookmarks/widget-horizontal.webp b/docs/widgets/bookmarks/widget-horizontal.webp similarity index 100% rename from docs/dashboards/widgets/bookmarks/widget-horizontal.webp rename to docs/widgets/bookmarks/widget-horizontal.webp diff --git a/docs/dashboards/widgets/calendar-widget.mdx b/docs/widgets/calendar-widget.mdx similarity index 91% rename from docs/dashboards/widgets/calendar-widget.mdx rename to docs/widgets/calendar-widget.mdx index 9ee2f504..6bbc3184 100644 --- a/docs/dashboards/widgets/calendar-widget.mdx +++ b/docs/widgets/calendar-widget.mdx @@ -7,8 +7,8 @@ tags: --- -The calendar Widget will use [Integrations](/docs/management/integrations/) to display upcoming content. -It can display content from [Sonarr](/docs/management/integrations/servarr#sonarr), [Radarr](/docs/management/integrations/servarr#radarr), [Lidarr](/docs/management/integrations/servarr#lidarr) and [Readarr](/docs/management/integrations/servarr#readarr). +The calendar Widget will use [Integrations](/docs/category/integrations) to display upcoming content. +It can display content from [Sonarr](/docs/integrations/servarr#sonarr), [Radarr](/docs/integrations/servarr#radarr), [Lidarr](/docs/integrations/servarr#lidarr) and [Readarr](/docs/integrations/servarr#readarr). --- diff --git a/docs/dashboards/widgets/clock-widget.mdx b/docs/widgets/clock-widget.mdx similarity index 100% rename from docs/dashboards/widgets/clock-widget.mdx rename to docs/widgets/clock-widget.mdx diff --git a/docs/dashboards/widgets/dashdot-widget.mdx b/docs/widgets/dashdot-widget.mdx similarity index 100% rename from docs/dashboards/widgets/dashdot-widget.mdx rename to docs/widgets/dashdot-widget.mdx diff --git a/docs/dashboards/widgets/dns-hole/controls-widget-badge-highlight.webp b/docs/widgets/dns-hole/controls-widget-badge-highlight.webp similarity index 100% rename from docs/dashboards/widgets/dns-hole/controls-widget-badge-highlight.webp rename to docs/widgets/dns-hole/controls-widget-badge-highlight.webp diff --git a/docs/dashboards/widgets/dns-hole/controls-widget-buttonless.webp b/docs/widgets/dns-hole/controls-widget-buttonless.webp similarity index 100% rename from docs/dashboards/widgets/dns-hole/controls-widget-buttonless.webp rename to docs/widgets/dns-hole/controls-widget-buttonless.webp diff --git a/docs/dashboards/widgets/dns-hole/controls-widget-configuration.webp b/docs/widgets/dns-hole/controls-widget-configuration.webp similarity index 100% rename from docs/dashboards/widgets/dns-hole/controls-widget-configuration.webp rename to docs/widgets/dns-hole/controls-widget-configuration.webp diff --git a/docs/dashboards/widgets/dns-hole/controls-widget.webp b/docs/widgets/dns-hole/controls-widget.webp similarity index 100% rename from docs/dashboards/widgets/dns-hole/controls-widget.webp rename to docs/widgets/dns-hole/controls-widget.webp diff --git a/docs/dashboards/widgets/dns-hole/get-api-token.webp b/docs/widgets/dns-hole/get-api-token.webp similarity index 100% rename from docs/dashboards/widgets/dns-hole/get-api-token.webp rename to docs/widgets/dns-hole/get-api-token.webp diff --git a/docs/dashboards/widgets/dns-hole/index.mdx b/docs/widgets/dns-hole/index.mdx similarity index 100% rename from docs/dashboards/widgets/dns-hole/index.mdx rename to docs/widgets/dns-hole/index.mdx diff --git a/docs/dashboards/widgets/dns-hole/summary-widget-colored.webp b/docs/widgets/dns-hole/summary-widget-colored.webp similarity index 100% rename from docs/dashboards/widgets/dns-hole/summary-widget-colored.webp rename to docs/widgets/dns-hole/summary-widget-colored.webp diff --git a/docs/dashboards/widgets/dns-hole/summary-widget-configuration.webp b/docs/widgets/dns-hole/summary-widget-configuration.webp similarity index 100% rename from docs/dashboards/widgets/dns-hole/summary-widget-configuration.webp rename to docs/widgets/dns-hole/summary-widget-configuration.webp diff --git a/docs/dashboards/widgets/dns-hole/summary-widget-horizontal.webp b/docs/widgets/dns-hole/summary-widget-horizontal.webp similarity index 100% rename from docs/dashboards/widgets/dns-hole/summary-widget-horizontal.webp rename to docs/widgets/dns-hole/summary-widget-horizontal.webp diff --git a/docs/dashboards/widgets/dns-hole/summary-widget-vertical.webp b/docs/widgets/dns-hole/summary-widget-vertical.webp similarity index 100% rename from docs/dashboards/widgets/dns-hole/summary-widget-vertical.webp rename to docs/widgets/dns-hole/summary-widget-vertical.webp diff --git a/docs/dashboards/widgets/dns-hole/summary-widget.webp b/docs/widgets/dns-hole/summary-widget.webp similarity index 100% rename from docs/dashboards/widgets/dns-hole/summary-widget.webp rename to docs/widgets/dns-hole/summary-widget.webp diff --git a/docs/dashboards/widgets/download-speed-widget.mdx b/docs/widgets/download-speed-widget.mdx similarity index 73% rename from docs/dashboards/widgets/download-speed-widget.mdx rename to docs/widgets/download-speed-widget.mdx index ebe6ef2d..b2f6864e 100644 --- a/docs/dashboards/widgets/download-speed-widget.mdx +++ b/docs/widgets/download-speed-widget.mdx @@ -7,7 +7,7 @@ tags: --- -The Download Speed Widget use [Integrations](/docs/management/integrations/) to display your current download and upload speed of supported Download Clients. +The Download Speed Widget use [Integrations](/docs/category/integrations) to display your current download and upload speed of supported Download Clients. --- @@ -18,7 +18,7 @@ Please check out our documentation on [how to add a widget](/docs/getting-starte ## Configuration -This widget does not offer any configurations. It will automatically use the configured [Download Client Integration](/docs/management/integrations/). +This widget does not offer any configurations. It will automatically use the configured [Download Client Integration](/docs/category/integrations). :::tip diff --git a/docs/dashboards/widgets/home-assistant/img/283935576-ac776c51-0333-4cda-84a5-07a2e660fcc1.png b/docs/widgets/home-assistant/img/283935576-ac776c51-0333-4cda-84a5-07a2e660fcc1.png similarity index 100% rename from docs/dashboards/widgets/home-assistant/img/283935576-ac776c51-0333-4cda-84a5-07a2e660fcc1.png rename to docs/widgets/home-assistant/img/283935576-ac776c51-0333-4cda-84a5-07a2e660fcc1.png diff --git a/docs/dashboards/widgets/home-assistant/img/copy-entity-id.png b/docs/widgets/home-assistant/img/copy-entity-id.png similarity index 100% rename from docs/dashboards/widgets/home-assistant/img/copy-entity-id.png rename to docs/widgets/home-assistant/img/copy-entity-id.png diff --git a/docs/dashboards/widgets/home-assistant/img/hass-token-copy.png b/docs/widgets/home-assistant/img/hass-token-copy.png similarity index 100% rename from docs/dashboards/widgets/home-assistant/img/hass-token-copy.png rename to docs/widgets/home-assistant/img/hass-token-copy.png diff --git a/docs/dashboards/widgets/home-assistant/index.mdx b/docs/widgets/home-assistant/index.mdx similarity index 97% rename from docs/dashboards/widgets/home-assistant/index.mdx rename to docs/widgets/home-assistant/index.mdx index ea23e9e3..c91e62ba 100644 --- a/docs/dashboards/widgets/home-assistant/index.mdx +++ b/docs/widgets/home-assistant/index.mdx @@ -28,7 +28,7 @@ To obtain a new token, log in on your Home Assistant and navigate: ### Adding a home assistant app to your board After copying the token you can add your app to the board. Make sure to enter the correct address and select **Home Assistant** as the integration. -Refer to [the introduction guide](../../../getting-started/prerequisites) for more information. +Refer to [the introduction guide](/docs/getting-started/) for more information. ### Add widget to fetch an entity state The last step is to add the widget itself to display an entity state. diff --git a/docs/dashboards/widgets/iframe/index.mdx b/docs/widgets/iframe/index.mdx similarity index 100% rename from docs/dashboards/widgets/iframe/index.mdx rename to docs/widgets/iframe/index.mdx diff --git a/docs/dashboards/widgets/iframe/widget.webp b/docs/widgets/iframe/widget.webp similarity index 100% rename from docs/dashboards/widgets/iframe/widget.webp rename to docs/widgets/iframe/widget.webp diff --git a/docs/dashboards/widgets/img/add-widget.webp b/docs/widgets/img/add-widget.webp similarity index 100% rename from docs/dashboards/widgets/img/add-widget.webp rename to docs/widgets/img/add-widget.webp diff --git a/docs/dashboards/widgets/img/calendar/sonarr-configure-credentials.gif b/docs/widgets/img/calendar/sonarr-configure-credentials.gif similarity index 100% rename from docs/dashboards/widgets/img/calendar/sonarr-configure-credentials.gif rename to docs/widgets/img/calendar/sonarr-configure-credentials.gif diff --git a/docs/dashboards/widgets/img/calendar/widget-calendar-configuration.webp b/docs/widgets/img/calendar/widget-calendar-configuration.webp similarity index 100% rename from docs/dashboards/widgets/img/calendar/widget-calendar-configuration.webp rename to docs/widgets/img/calendar/widget-calendar-configuration.webp diff --git a/docs/dashboards/widgets/img/calendar/widget-calendar-dark-mode.webp b/docs/widgets/img/calendar/widget-calendar-dark-mode.webp similarity index 100% rename from docs/dashboards/widgets/img/calendar/widget-calendar-dark-mode.webp rename to docs/widgets/img/calendar/widget-calendar-dark-mode.webp diff --git a/docs/dashboards/widgets/img/calendar/widget-calendar-day-information.webp b/docs/widgets/img/calendar/widget-calendar-day-information.webp similarity index 100% rename from docs/dashboards/widgets/img/calendar/widget-calendar-day-information.webp rename to docs/widgets/img/calendar/widget-calendar-day-information.webp diff --git a/docs/dashboards/widgets/img/calendar/widget-calendar-indicators.webp b/docs/widgets/img/calendar/widget-calendar-indicators.webp similarity index 100% rename from docs/dashboards/widgets/img/calendar/widget-calendar-indicators.webp rename to docs/widgets/img/calendar/widget-calendar-indicators.webp diff --git a/docs/dashboards/widgets/img/calendar/widget-calendar-integration-api-key-link.webp b/docs/widgets/img/calendar/widget-calendar-integration-api-key-link.webp similarity index 100% rename from docs/dashboards/widgets/img/calendar/widget-calendar-integration-api-key-link.webp rename to docs/widgets/img/calendar/widget-calendar-integration-api-key-link.webp diff --git a/docs/dashboards/widgets/img/calendar/widget-calendar-integration-lidarr-missing-poster.webp b/docs/widgets/img/calendar/widget-calendar-integration-lidarr-missing-poster.webp similarity index 100% rename from docs/dashboards/widgets/img/calendar/widget-calendar-integration-lidarr-missing-poster.webp rename to docs/widgets/img/calendar/widget-calendar-integration-lidarr-missing-poster.webp diff --git a/docs/dashboards/widgets/img/calendar/widget-calendar-integration-sonarr-example.webp b/docs/widgets/img/calendar/widget-calendar-integration-sonarr-example.webp similarity index 100% rename from docs/dashboards/widgets/img/calendar/widget-calendar-integration-sonarr-example.webp rename to docs/widgets/img/calendar/widget-calendar-integration-sonarr-example.webp diff --git a/docs/dashboards/widgets/img/calendar/widget-calendar-integration-sonarr-poster.webp b/docs/widgets/img/calendar/widget-calendar-integration-sonarr-poster.webp similarity index 100% rename from docs/dashboards/widgets/img/calendar/widget-calendar-integration-sonarr-poster.webp rename to docs/widgets/img/calendar/widget-calendar-integration-sonarr-poster.webp diff --git a/docs/dashboards/widgets/img/calendar/widget-calendar-light-mode.webp b/docs/widgets/img/calendar/widget-calendar-light-mode.webp similarity index 100% rename from docs/dashboards/widgets/img/calendar/widget-calendar-light-mode.webp rename to docs/widgets/img/calendar/widget-calendar-light-mode.webp diff --git a/docs/dashboards/widgets/img/calendar/widget-calendar-show.gif b/docs/widgets/img/calendar/widget-calendar-show.gif similarity index 100% rename from docs/dashboards/widgets/img/calendar/widget-calendar-show.gif rename to docs/widgets/img/calendar/widget-calendar-show.gif diff --git a/docs/dashboards/widgets/img/choose-widget-in-modal.webp b/docs/widgets/img/choose-widget-in-modal.webp similarity index 100% rename from docs/dashboards/widgets/img/choose-widget-in-modal.webp rename to docs/widgets/img/choose-widget-in-modal.webp diff --git a/docs/dashboards/widgets/img/choose-widgets-in-modal.webp b/docs/widgets/img/choose-widgets-in-modal.webp similarity index 100% rename from docs/dashboards/widgets/img/choose-widgets-in-modal.webp rename to docs/widgets/img/choose-widgets-in-modal.webp diff --git a/docs/dashboards/widgets/img/clock/widget-clock-configuration-date-formatting.webp b/docs/widgets/img/clock/widget-clock-configuration-date-formatting.webp similarity index 100% rename from docs/dashboards/widgets/img/clock/widget-clock-configuration-date-formatting.webp rename to docs/widgets/img/clock/widget-clock-configuration-date-formatting.webp diff --git a/docs/dashboards/widgets/img/clock/widget-clock-configuration.webp b/docs/widgets/img/clock/widget-clock-configuration.webp similarity index 100% rename from docs/dashboards/widgets/img/clock/widget-clock-configuration.webp rename to docs/widgets/img/clock/widget-clock-configuration.webp diff --git a/docs/dashboards/widgets/img/clock/widget-clock-dark-mode.webp b/docs/widgets/img/clock/widget-clock-dark-mode.webp similarity index 100% rename from docs/dashboards/widgets/img/clock/widget-clock-dark-mode.webp rename to docs/widgets/img/clock/widget-clock-dark-mode.webp diff --git a/docs/dashboards/widgets/img/clock/widget-clock-light-mode.webp b/docs/widgets/img/clock/widget-clock-light-mode.webp similarity index 100% rename from docs/dashboards/widgets/img/clock/widget-clock-light-mode.webp rename to docs/widgets/img/clock/widget-clock-light-mode.webp diff --git a/docs/dashboards/widgets/img/dashDot/widget-dashdot-configuration.webp b/docs/widgets/img/dashDot/widget-dashdot-configuration.webp similarity index 100% rename from docs/dashboards/widgets/img/dashDot/widget-dashdot-configuration.webp rename to docs/widgets/img/dashDot/widget-dashdot-configuration.webp diff --git a/docs/dashboards/widgets/img/dashDot/widget-dashdot-light-mode.webp b/docs/widgets/img/dashDot/widget-dashdot-light-mode.webp similarity index 100% rename from docs/dashboards/widgets/img/dashDot/widget-dashdot-light-mode.webp rename to docs/widgets/img/dashDot/widget-dashdot-light-mode.webp diff --git a/docs/dashboards/widgets/img/media-server/media-server-widget.webp b/docs/widgets/img/media-server/media-server-widget.webp similarity index 100% rename from docs/dashboards/widgets/img/media-server/media-server-widget.webp rename to docs/widgets/img/media-server/media-server-widget.webp diff --git a/docs/dashboards/widgets/img/media-server/stats-for-nerds.webp b/docs/widgets/img/media-server/stats-for-nerds.webp similarity index 100% rename from docs/dashboards/widgets/img/media-server/stats-for-nerds.webp rename to docs/widgets/img/media-server/stats-for-nerds.webp diff --git a/docs/dashboards/widgets/img/networkSpeed/widget-download-speed-dark.webp b/docs/widgets/img/networkSpeed/widget-download-speed-dark.webp similarity index 100% rename from docs/dashboards/widgets/img/networkSpeed/widget-download-speed-dark.webp rename to docs/widgets/img/networkSpeed/widget-download-speed-dark.webp diff --git a/docs/dashboards/widgets/img/networkSpeed/widget-download-speed.webp b/docs/widgets/img/networkSpeed/widget-download-speed.webp similarity index 100% rename from docs/dashboards/widgets/img/networkSpeed/widget-download-speed.webp rename to docs/widgets/img/networkSpeed/widget-download-speed.webp diff --git a/docs/dashboards/widgets/img/rss/rss-widget-config.webp b/docs/widgets/img/rss/rss-widget-config.webp similarity index 100% rename from docs/dashboards/widgets/img/rss/rss-widget-config.webp rename to docs/widgets/img/rss/rss-widget-config.webp diff --git a/docs/dashboards/widgets/img/rss/rss-widget.webp b/docs/widgets/img/rss/rss-widget.webp similarity index 100% rename from docs/dashboards/widgets/img/rss/rss-widget.webp rename to docs/widgets/img/rss/rss-widget.webp diff --git a/docs/dashboards/widgets/img/torrent/widget-torrent-app-type-example.webp b/docs/widgets/img/torrent/widget-torrent-app-type-example.webp similarity index 100% rename from docs/dashboards/widgets/img/torrent/widget-torrent-app-type-example.webp rename to docs/widgets/img/torrent/widget-torrent-app-type-example.webp diff --git a/docs/dashboards/widgets/img/torrent/widget-torrent-configuration.webp b/docs/widgets/img/torrent/widget-torrent-configuration.webp similarity index 100% rename from docs/dashboards/widgets/img/torrent/widget-torrent-configuration.webp rename to docs/widgets/img/torrent/widget-torrent-configuration.webp diff --git a/docs/dashboards/widgets/img/torrent/widget-torrent.webp b/docs/widgets/img/torrent/widget-torrent.webp similarity index 100% rename from docs/dashboards/widgets/img/torrent/widget-torrent.webp rename to docs/widgets/img/torrent/widget-torrent.webp diff --git a/docs/dashboards/widgets/img/usenet/widget-usenet-dark.webp b/docs/widgets/img/usenet/widget-usenet-dark.webp similarity index 100% rename from docs/dashboards/widgets/img/usenet/widget-usenet-dark.webp rename to docs/widgets/img/usenet/widget-usenet-dark.webp diff --git a/docs/dashboards/widgets/img/usenet/widget-usenet.webp b/docs/widgets/img/usenet/widget-usenet.webp similarity index 100% rename from docs/dashboards/widgets/img/usenet/widget-usenet.webp rename to docs/widgets/img/usenet/widget-usenet.webp diff --git a/docs/dashboards/widgets/img/weather/widget-weather-configuration.webp b/docs/widgets/img/weather/widget-weather-configuration.webp similarity index 100% rename from docs/dashboards/widgets/img/weather/widget-weather-configuration.webp rename to docs/widgets/img/weather/widget-weather-configuration.webp diff --git a/docs/dashboards/widgets/img/weather/widget-weather-dark-mode.webp b/docs/widgets/img/weather/widget-weather-dark-mode.webp similarity index 100% rename from docs/dashboards/widgets/img/weather/widget-weather-dark-mode.webp rename to docs/widgets/img/weather/widget-weather-dark-mode.webp diff --git a/docs/dashboards/widgets/img/weather/widget-weather-light-mode.webp b/docs/widgets/img/weather/widget-weather-light-mode.webp similarity index 100% rename from docs/dashboards/widgets/img/weather/widget-weather-light-mode.webp rename to docs/widgets/img/weather/widget-weather-light-mode.webp diff --git a/docs/dashboards/widgets/media-requests/index.mdx b/docs/widgets/media-requests/index.mdx similarity index 91% rename from docs/dashboards/widgets/media-requests/index.mdx rename to docs/widgets/media-requests/index.mdx index 7ed03e3f..90354094 100644 --- a/docs/dashboards/widgets/media-requests/index.mdx +++ b/docs/widgets/media-requests/index.mdx @@ -7,7 +7,7 @@ tags: - Jellyserr --- -The media requests widget enables you to integrate with [Overseerr and Jellyseerr](/docs/management/integrations/media-requester#overseerr--jellyseerr). +The media requests widget enables you to integrate with [Overseerr and Jellyseerr](/docs/integrations/media-requester). Using the widget, you can view the current media requests. --- diff --git a/docs/dashboards/widgets/media-requests/widget-configuration.webp b/docs/widgets/media-requests/widget-configuration.webp similarity index 100% rename from docs/dashboards/widgets/media-requests/widget-configuration.webp rename to docs/widgets/media-requests/widget-configuration.webp diff --git a/docs/dashboards/widgets/media-requests/widget-statistics.webp b/docs/widgets/media-requests/widget-statistics.webp similarity index 100% rename from docs/dashboards/widgets/media-requests/widget-statistics.webp rename to docs/widgets/media-requests/widget-statistics.webp diff --git a/docs/dashboards/widgets/media-requests/widget.webp b/docs/widgets/media-requests/widget.webp similarity index 100% rename from docs/dashboards/widgets/media-requests/widget.webp rename to docs/widgets/media-requests/widget.webp diff --git a/docs/dashboards/widgets/media-server.mdx b/docs/widgets/media-server.mdx similarity index 100% rename from docs/dashboards/widgets/media-server.mdx rename to docs/widgets/media-server.mdx diff --git a/docs/dashboards/widgets/notebook/index.mdx b/docs/widgets/notebook/index.mdx similarity index 100% rename from docs/dashboards/widgets/notebook/index.mdx rename to docs/widgets/notebook/index.mdx diff --git a/docs/dashboards/widgets/notebook/notebook-enter-editing.webp b/docs/widgets/notebook/notebook-enter-editing.webp similarity index 100% rename from docs/dashboards/widgets/notebook/notebook-enter-editing.webp rename to docs/widgets/notebook/notebook-enter-editing.webp diff --git a/docs/dashboards/widgets/notebook/notebook-exit-editing.webp b/docs/widgets/notebook/notebook-exit-editing.webp similarity index 100% rename from docs/dashboards/widgets/notebook/notebook-exit-editing.webp rename to docs/widgets/notebook/notebook-exit-editing.webp diff --git a/docs/dashboards/widgets/notebook/notebook-image-modal.webp b/docs/widgets/notebook/notebook-image-modal.webp similarity index 100% rename from docs/dashboards/widgets/notebook/notebook-image-modal.webp rename to docs/widgets/notebook/notebook-image-modal.webp diff --git a/docs/dashboards/widgets/notebook/notebook-link-modal.webp b/docs/widgets/notebook/notebook-link-modal.webp similarity index 100% rename from docs/dashboards/widgets/notebook/notebook-link-modal.webp rename to docs/widgets/notebook/notebook-link-modal.webp diff --git a/docs/dashboards/widgets/notebook/notebook-table-modal.webp b/docs/widgets/notebook/notebook-table-modal.webp similarity index 100% rename from docs/dashboards/widgets/notebook/notebook-table-modal.webp rename to docs/widgets/notebook/notebook-table-modal.webp diff --git a/docs/dashboards/widgets/notebook/notebook-toolbar-lists.webp b/docs/widgets/notebook/notebook-toolbar-lists.webp similarity index 100% rename from docs/dashboards/widgets/notebook/notebook-toolbar-lists.webp rename to docs/widgets/notebook/notebook-toolbar-lists.webp diff --git a/docs/dashboards/widgets/notebook/notebook-toolbar-table.webp b/docs/widgets/notebook/notebook-toolbar-table.webp similarity index 100% rename from docs/dashboards/widgets/notebook/notebook-toolbar-table.webp rename to docs/widgets/notebook/notebook-toolbar-table.webp diff --git a/docs/dashboards/widgets/notebook/notebook-toolbar.webp b/docs/widgets/notebook/notebook-toolbar.webp similarity index 100% rename from docs/dashboards/widgets/notebook/notebook-toolbar.webp rename to docs/widgets/notebook/notebook-toolbar.webp diff --git a/docs/dashboards/widgets/notebook/widget-configuration.webp b/docs/widgets/notebook/widget-configuration.webp similarity index 100% rename from docs/dashboards/widgets/notebook/widget-configuration.webp rename to docs/widgets/notebook/widget-configuration.webp diff --git a/docs/dashboards/widgets/notebook/widget.webp b/docs/widgets/notebook/widget.webp similarity index 100% rename from docs/dashboards/widgets/notebook/widget.webp rename to docs/widgets/notebook/widget.webp diff --git a/docs/dashboards/widgets/rss-widget.mdx b/docs/widgets/rss-widget.mdx similarity index 100% rename from docs/dashboards/widgets/rss-widget.mdx rename to docs/widgets/rss-widget.mdx diff --git a/docs/dashboards/widgets/torrent-widget.mdx b/docs/widgets/torrent-widget.mdx similarity index 87% rename from docs/dashboards/widgets/torrent-widget.mdx rename to docs/widgets/torrent-widget.mdx index 2ed294cf..42eaf1ef 100644 --- a/docs/dashboards/widgets/torrent-widget.mdx +++ b/docs/widgets/torrent-widget.mdx @@ -6,7 +6,7 @@ tags: - Configuration --- -The Torrent widget uses [Integrations](/docs/management/integrations/) to display a list of torrents with their name, download/upload speed and progress. +The Torrent widget uses [Integrations](/docs/category/integrations) to display a list of torrents with their name, download/upload speed and progress. --- diff --git a/docs/dashboards/widgets/usenet-widget.mdx b/docs/widgets/usenet-widget.mdx similarity index 71% rename from docs/dashboards/widgets/usenet-widget.mdx rename to docs/widgets/usenet-widget.mdx index 7dbb3a01..3bedcdce 100644 --- a/docs/dashboards/widgets/usenet-widget.mdx +++ b/docs/widgets/usenet-widget.mdx @@ -6,7 +6,7 @@ tags: - Configuration --- -The Usenet widget uses [Integrations](/docs/management/integrations/) to display a list of usenets with their name, download/upload speed and progress. +The Usenet widget uses [Integrations](/docs/category/integrations) to display a list of usenets with their name, download/upload speed and progress. --- ## Adding the widget @@ -15,7 +15,7 @@ Please check out our documentation on [how to add a widget](/docs/getting-starte --- ## Configuration -This widget does not offer any configurations. It will automatically use the configured [Usenet Client Integration](/docs/management/integrations/). +This widget does not offer any configurations. It will automatically use the configured [Usenet Client Integration](/docs/category/integrations). :::tip Check out our documentation on [editing tiles](/docs/getting-started/after-the-installation#organizing-and-re-arranging-your-dashboard). diff --git a/docs/dashboards/widgets/video/index.mdx b/docs/widgets/video/index.mdx similarity index 100% rename from docs/dashboards/widgets/video/index.mdx rename to docs/widgets/video/index.mdx diff --git a/docs/dashboards/widgets/video/widget.webp b/docs/widgets/video/widget.webp similarity index 100% rename from docs/dashboards/widgets/video/widget.webp rename to docs/widgets/video/widget.webp diff --git a/docs/dashboards/widgets/weather-widget.mdx b/docs/widgets/weather-widget.mdx similarity index 100% rename from docs/dashboards/widgets/weather-widget.mdx rename to docs/widgets/weather-widget.mdx diff --git a/docusaurus.config.ts b/docusaurus.config.ts index a779d155..88cd7e33 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -1,5 +1,5 @@ -import type { Config, PluginOptions } from '@docusaurus/types'; import type * as Preset from '@docusaurus/preset-classic'; +import type { Config } from '@docusaurus/types'; import { themes as prismThemes } from 'prism-react-renderer'; import { EnumChangefreq } from 'sitemap'; @@ -82,71 +82,47 @@ const config: Config = { }, 'items': [ { - label: 'Getting started', + label: 'Docs', type: 'doc', position: 'left', - docId: 'getting-started/prerequisites', + docId: 'getting-started/index', }, { - label: 'Boards', - type: 'doc', + label: 'More', position: 'left', - docId: 'dashboards/apps/index', + to: '/docs/category/more', }, { - label: 'Management', - type: 'doc', + label: 'Blog', position: 'left', - docId: 'management/resources/index', + to: '/blog', }, { - label: 'Advanced', - type: 'doc', + label: 'About us', position: 'left', - docId: 'advanced/customizations/icons', + to: '/about-us', }, { - label: 'Community', - position: 'left', - type: 'doc', - docId: 'community/faq', + to: 'https://demo.homarr.dev/', + label: 'Demo', + position: 'right', }, { type: 'dropdown', - label: 'About us', - position: 'left', + label: 'Community', + position: 'right', items: [ { - to: '/about-us', - label: 'Our team', - }, - { - to: '/blog', - label: 'Blog', - }, - ], - }, - { - 'to': 'https://demo.homarr.dev/', - 'label': 'Demo', - 'position': 'right', - }, - { - 'type': 'dropdown', - 'label': 'Community', - 'position': 'right', - 'items': [ - { - 'to': 'https://discord.com/invite/aCsmEV5RgA', - 'label': 'Discord', + to: 'https://discord.com/invite/aCsmEV5RgA', + label: 'Discord', }, { - 'to': 'https://github.com/ajnart/homarr', - 'label': 'GitHub', + to: 'https://github.com/ajnart/homarr', + label: 'GitHub', }, { - 'to': 'https://www.answeroverflow.com/c/972958686051962910', - 'label': 'Answer Overflow', + to: 'https://www.answeroverflow.com/c/972958686051962910', + label: 'Answer Overflow', }, { to: 'https://crowdin.com/project/homarr', @@ -176,7 +152,7 @@ const config: Config = { items: [ { label: 'Installation', - to: '/docs/getting-started/prerequisites', + to: '/docs/category/getting-started', } ], }, diff --git a/sidebars.js b/sidebars.js index f5ed312e..115aa8ed 100644 --- a/sidebars.js +++ b/sidebars.js @@ -15,10 +15,8 @@ const sidebars = { // By default, Docusaurus generates a sidebar from the docs folder structure GettingStarted: [{ type: 'autogenerated', dirName: 'getting-started' }], - Dashboards: [{ type: 'autogenerated', dirName: 'dashboards' }], - Management: [{ type: 'autogenerated', dirName: 'management' }], + Docs: [{ type: 'autogenerated', dirName: '.' }], Advanced: [{ type: 'autogenerated', dirName: 'advanced' }], - Community: [{ type: 'autogenerated', dirName: 'community' }], // But you can create a sidebar manually /* diff --git a/src/components/pages/home/hero/hero.tsx b/src/components/pages/home/hero/hero.tsx index b8728127..e6c78c57 100644 --- a/src/components/pages/home/hero/hero.tsx +++ b/src/components/pages/home/hero/hero.tsx @@ -1,9 +1,8 @@ -import clsx from 'clsx'; -import styles from '../../../../pages/index.module.css'; import Link from '@docusaurus/Link'; -import { IconDownload, IconInfoCircle } from '@tabler/icons'; import { useColorMode } from '@docusaurus/theme-common'; -import React from 'react'; +import { IconDownload } from '@tabler/icons'; +import clsx from 'clsx'; +import styles from '../../../../pages/index.module.css'; export default function HomeHero() { return ( @@ -24,7 +23,7 @@ export default function HomeHero() {
Install