feat(docs): versioning (autobrr#127)

s0up4200 · web-flow · commit cb3ea08754e2 · 2023-10-26T20:18:02.000+02:00
* prepare all links for versioning

* feat(docs): add versioning
diff --git a/docs/configuration/autobrr.md b/docs/configuration/autobrr.md
@@ -109,10 +109,10 @@ autobrrctl --config ~/.config/autobrr create-user USERNAME
 
 Make sure to read through all of the articles as all of them have some important information on how to get autobrr up and running.
 
-- [Indexers <CgWebsite />](/configuration/indexers)
-- [IRC <BsChatDotsFill />](/configuration/irc)
-- [Download Clients <FaDownload />](/configuration/download-clients/dedicated)
-- [Feeds (RSS / Torznab / Newznab) <MdRssFeed />](/configuration/feeds)
+- [Indexers <CgWebsite />](./indexers.md)
+- [IRC <BsChatDotsFill />](./irc.md)
+- [Download Clients <FaDownload />](./download-clients/dedi.md)
+- [Feeds (RSS / Torznab / Newznab) <MdRssFeed />](./feeds.md)
 
 ## Additional help
 
diff --git a/docs/configuration/download-clients/dedi.md b/docs/configuration/download-clients/dedi.md
@@ -1,6 +1,6 @@
 ---
+id: dedi
 sidebar_label: Dedicated servers
-slug: /configuration/download-clients/dedicated
 title: Download Clients
 description: A guide on how to set up download clients in autobrr.
 keywords:
@@ -262,6 +262,7 @@ For a local client, meaning autobrr and Sabnzbd **on the same server** then this
 - Host: `http://127.0.0.1:SABNZBD_PORT`
 - TLS: disabled
 - API key
+
 ### Remote {#sabnzbd-remote}
 
 For a remote client, meaning autobrr and qBittorrent are **not on the same server** then things might be a bit different.
@@ -275,6 +276,7 @@ Some setups like **Swizzin** requires to also use **Basic Auth** when connecting
 - Basic Auth: enabled
 - Username: `<username>`
 - Password: `<password>`
+
 ## Sonarr
 
 You can run autobrr and Sonarr apps on the following setups.
diff --git a/docs/configuration/download-clients/shared.md b/docs/configuration/download-clients/shared.md
@@ -1,6 +1,5 @@
 ---
 id: shared
-slug: /configuration/download-clients/shared-seedboxes
 sidebar_label: Shared seedboxes
 #sidebar_position: 3
 title: Connecting to download clients on a shared seedbox
diff --git a/docs/configuration/indexers.md b/docs/configuration/indexers.md
@@ -53,14 +53,14 @@ If you want more indexers added please create an [Indexer Request](https://githu
 
    For example, torrentleech provides their users with [this](http://wiki.torrentleech.org/doku.php/autobrr) page.
 
-   - If NickServ Password is marked `*` as required, then you need to have a registered account on that IRC network. See [registering with NickServ](/configuration/irc#registering-with-nickserv).
+   - If NickServ Password is marked `*` as required, then you need to have a registered account on that IRC network. See [registering with NickServ](irc.md#registering-with-nickserv).
    - If NickServ Account is marked `*` as required, that's only used as nick, but supports NickServ auth.
    - The invite command field in `Settings > IRC > Edit network` are pre filled, but you need to add your IRC key. The rest should be left as is.
 
 1. After the indexer is set up, head to `Settings > IRC` and click the 3 dots for the newly created network, hit `Edit`, and then enable the network. This is a good time to look over everything. The invite command etc.
 
 :::caution Important
-Please check the [IRC](/configuration/irc) section for more details regarding NickServ, IRC keys, and grouping of nicks.
+Please check the [IRC](../configuration/irc.md) section for more details regarding NickServ, IRC keys, and grouping of nicks.
 :::
 
 <IpApproval/>
diff --git a/docs/configuration/irc.md b/docs/configuration/irc.md
@@ -86,7 +86,7 @@ You shouldn't need to worry about it, but it's nice now to know what you need to
 
 ## Setup
 
-The initial setup of IRC networks and channels are done during the setup of [indexers](/configuration/indexers).
+The initial setup of IRC networks and channels are done during the setup of [indexers](../configuration/indexers.md).
 
 If you for some reason need to setup a network manually, or edit an existing one, you can do that in `Settings > IRC`.
 
@@ -165,7 +165,7 @@ You may need to enable some modules for the network based on the networks setup.
 
 #### Enabling SSL
 
-While this is not required, it might be easier to get going than you think. This section is based on already having Linuxserver´s SWAG  generating a certificate for `znc.mydomain.com`, while keeping all traffic between containers inside the same docker network.
+While this is not required, it might be easier to get going than you think. This section is based on already having Linuxserver´s SWAG generating a certificate for `znc.mydomain.com`, while keeping all traffic between containers inside the same docker network.
 
 There is two changes that need to be done to the compose example to allow this to work.
 
diff --git a/docs/faqs.md b/docs/faqs.md
@@ -80,14 +80,14 @@ With TorrentLeech as an example, only add the red part when setting up your inde
 
 `https://rss.tl.org/`<Highlight color="#ff2754">1812u12urr1203j12jeq</Highlight>
 
-In case you are still having troubles with setting up the TorrentLeech indexer,   
+In case you are still having troubles with setting up the TorrentLeech indexer,  
 you can find detailed instructions for the setup process on their wiki:
 
 https://wiki.torrentleech.org/doku.php/autobrr
 
 ## I have set up an indexer, but it does not connect to the #announce channel. What do I do?
 
-Make sure you have entered the necessary keys in the invite command and that your IRC user has privileges to access to the #announce channel. See [IRC setup](/configuration/irc).
+Make sure you have entered the necessary keys in the invite command and that your IRC user has privileges to access to the #announce channel. See [IRC setup](./configuration/irc.md).
 
 import Botnaming from '/snippets/botnaming.mdx';
 
@@ -129,11 +129,11 @@ Use the command line or an sqlite editor.
 
 ### CLI
 
-You need the `sqlite3` package for this. 
+You need the `sqlite3` package for this.
 
-* If you are using our docker container then you can exec in and run `apk add sqlite3`.
-* Ubuntu: `sudo apt install sqlite3`
-* On other linux based systems use the package manager to install the package
+- If you are using our docker container then you can exec in and run `apk add sqlite3`.
+- Ubuntu: `sudo apt install sqlite3`
+- On other linux based systems use the package manager to install the package
 
 `sqlite3 autobrr.db "UPDATE users SET username = 'newuser';"`
 
@@ -149,7 +149,7 @@ Or use the gui to click edit on the `username` column of the `users` table.
 
 ## How can I use my freeleech tokens from RED? {#redacted-freeleech-tokens}
 
-This is something a lot of users are asking for. 
+This is something a lot of users are asking for.
 
 Golden Rule 5.3 on RED:
 
diff --git a/docs/filters/actions.md b/docs/filters/actions.md
@@ -26,14 +26,15 @@ pagination_label: Filters - Actions
 
 A configured action is what your autodl does with a successful push. You can send it any of the supported actions. Each filter supports multiple actions just incase you need to send to multiple clients, or run custom commands as well.
 
-Make sure you've set up a [download client](/configuration/download-clients/dedicated) before continuing further.
+Make sure you've set up a [download client](../configuration/download-clients/dedi.md) before continuing further.
 
 Whether you're adding, updating or removing actions on a filter, make sure to <strong>save</strong> the filter afterwards.
 
 ### Macros
-Many of the action fields have support for [macros](/filters/macros), which allow you to enhance your workflow significantly by providing custom logic/data processing to the input data provided by autobrr.
 
-This [section](/filters/macros) has been moved to its own page.
+Many of the action fields have support for [macros](../filters/macros.md), which allow you to enhance your workflow significantly by providing custom logic/data processing to the input data provided by autobrr.
+
+This [section](../filters/macros.md) has been moved to its own page.
 
 ## Supported actions
 
@@ -125,7 +126,7 @@ Autobrr supports the ability to push directly to the \*arr suite of services.
 
 Could be useful to do some basic filtering before sending.
 
-Select the type, and then the client. Read more about setup in [download clients setup](/configuration/download-clients/dedicated).
+Select the type, and then the client. Read more about setup in [download clients setup](../configuration/download-clients/dedi.md).
 
 Supports both local and remote instances.
 
@@ -163,4 +164,4 @@ There is no built in native FTP upload action but you can get around this with a
 - Command: `scp`
 - Args: `{{ .TorrentPathName }} <username>@<hostname>:<destination path>`
 
-![FTP/SFTP](../../static/img/SCP.png "Exec action")
+![FTP/SFTP](../../static//img/SCP.png "Exec action")
diff --git a/docs/filters/advanced.md b/docs/filters/advanced.md
@@ -54,7 +54,7 @@ Not all announces category, check [this list](./categories.md) for indexer speci
 
 Not supported by all indexers. Check [this list](./freeleech.md) for indexer specifics.
 
-| Field                 | Description                                            | Examples           | Availability                                                     |
-| --------------------- | ------------------------------------------------------ | ------------------ | ---------------------------------------------------------------- |
-| **Freeleech**         | Should this filter match only Freeleech releases?      |                    | [Depends on Indexer](/filters/freeleech)                         |
-| **Freeleech Percent** | Allowed Freeleech Percentage for this filter to match. | e.g. `50%,75-100%` | [Depends on Indexer, might not use percent.](/filters/freeleech) |
+| Field                 | Description                                            | Examples           | Availability                                                 |
+| --------------------- | ------------------------------------------------------ | ------------------ | ------------------------------------------------------------ |
+| **Freeleech**         | Should this filter match only Freeleech releases?      |                    | [Depends on Indexer](./freeleech.md)                         |
+| **Freeleech Percent** | Allowed Freeleech Percentage for this filter to match. | e.g. `50%,75-100%` | [Depends on Indexer, might not use percent.](./freeleech.md) |
diff --git a/docs/filters/examples.md b/docs/filters/examples.md
@@ -32,10 +32,10 @@ When using autobrr with Sonarr these are some good recommendation filters to sta
 
 It's advisable to setup your Sonarr properly with the help of [Trash-guides](https://trash-guides.info) and then just do some light filtering of releases to not push unwanted releases to Sonarr.
 
-Don't forget to add a [Sonarr action](/filters/actions#radarr-sonarr-lidarr-readarr-and-whisparr)!
+Don't forget to add a [Sonarr action](../filters/actions.md#radarr-sonarr-lidarr-readarr-and-whisparr)!
 
 :::caution Important
-Not all indexers announce video **container** like `mkv` or `mp4`. It's best to leave this off. 
+Not all indexers announce video **container** like `mkv` or `mp4`. It's best to leave this off.
 :::
 
 ### HD WEB (720p, 1080p)
@@ -48,7 +48,6 @@ Set this to match your quality settings in Sonarr
 | Sources          | [WEB, WEB-DL, WEBRip]                 |
 | Match Categories | [Depends on Indexer](./categories.md) |
 
-
 ### 4k (2160p)
 
 Set this to match your quality settings in Sonarr
@@ -99,10 +98,10 @@ When using autobrr with Radarr these are some good recommendation filters to sta
 
 It's advisable to setup your Radarr properly with the help of [Trash-guides](https://trash-guides.info) and then just do some light filtering of releases to not push unwanted releases to Radarr.
 
-Don't forget to add a [Radarr action](/filters/actions#radarr-sonarr-lidarr-and-whisparr)!
+Don't forget to add a [Radarr action](./actions.md#radarr-sonarr-lidarr-readarr-and-whisparr)!
 
 :::caution Important
-Not all indexers announce video **container** like `mkv` or `mp4`. It's best to leave this off. 
+Not all indexers announce video **container** like `mkv` or `mp4`. It's best to leave this off.
 :::
 
 ### HD (720p, 1080p)
@@ -145,7 +144,7 @@ If you **DON'T WANT ANY HDR** formats
 
 If you are in need of buffer this is an example that will work will on general indexers with freeleech/bonus systems.
 
-Check your indexer or our [list of indexers supporting freeleech](/filters/freeleech) filtering for specifics.
+Check your indexer or our [list of indexers supporting freeleech](./freeleech.md) filtering for specifics.
 
 | Field     | Values        |
 | --------- | ------------- |
diff --git a/docs/filters/external.md b/docs/filters/external.md
@@ -13,13 +13,13 @@ pagination_next: filters/actions
 
 With external filters you can run `scripts` and `webhooks` to do your own custom filtering. If **Expected exit status** matches it will continue. If not it stops there.
 
-Many of the fields have support for [macros](/filters/macros), which allow you to enhance your workflow significantly by providing custom logic/data processing to the input data provided by autobrr.
+Many of the fields have support for [macros](./macros.md), which allow you to enhance your workflow significantly by providing custom logic/data processing to the input data provided by autobrr.
 
 ### Script
 
 Run external script that does something. Use `exit codes` correctly, like `exit 0` for no issues. In Linux, non-zero exit codes are considered not-ok/error etc.
 
-See [stop if disk is full](/usage/tips#stop-if-disk-is-full) for a good example of what it can do.
+See [stop if disk is full](../usage/tips.md#stop-if-disk-is-full) for a good example of what it can do.
 
 | Field                    | Description           | Examples                                                       |
 | ------------------------ | --------------------- | -------------------------------------------------------------- |
diff --git a/docs/filters/music.md b/docs/filters/music.md
@@ -9,7 +9,7 @@ pagination_label: Filters - Music
 pagination_next: filters/advanced
 ---
 
-# Filters
+# Music
 
 :::tip
 You can easily convert your autodl-irssi filters into autobrr filters using our conversion tool. Visit https://convert.autobrr.com and follow the simple steps to convert each filter individually.
diff --git a/docs/installation/docker.md b/docs/installation/docker.md
@@ -67,7 +67,7 @@ environment:
 
 ### Manually configure autobrr (optional) {#manually-configure-autobrr}
 
-You can either let autobrr create the config itself at startup, or create one manually. For more information, please visit [configuring autobrr](/configuration/autobrr) which covers creating a user manually, configuring the default port, setting the desired log level, etc.
+You can either let autobrr create the config itself at startup, or create one manually. For more information, please visit [configuring autobrr](../configuration/autobrr.md) which covers creating a user manually, configuring the default port, setting the desired log level, etc.
 
 ### Start the container
 
diff --git a/docs/installation/linux.md b/docs/installation/linux.md
@@ -30,7 +30,7 @@ Welcome to the autobrr installation walkthrough!
 Follow these steps and we will have you up and running in no time.
 
 Follow instructions below for recommended setup on a regular Linux server.
-Additionally see our installation instructions for [Docker <FaDocker />](/installation/docker) and [Windows <FaWindows />](/installation/windows).
+Additionally see our installation instructions for [Docker <FaDocker />](./docker.md) and [Windows <FaWindows />](./windows.md).
 
 import SeedboxSolutionInstallers from '/snippets/seedbox-solution-installers.mdx';
 
@@ -59,7 +59,7 @@ sudo tar -C /usr/local/bin -xzf autobrr*.tar.gz
 This will extract both `autobrr` and `autobrrctl` to `/usr/local/bin`.
 
 :::info
-If you do not have root, or are on a shared system, place the binaries somewhere in your home directory like `~/.bin` or use our installers for [shared seedboxes](/installation/shared-seedbox).
+If you do not have root, or are on a shared system, place the binaries somewhere in your home directory like `~/.bin` or use our installers for [shared seedboxes](../installation/shared-seedbox.md).
 :::
 
 ### Configuration
@@ -72,7 +72,7 @@ mkdir -p ~/.config/autobrr
 
 #### Manually configure autobrr (optional)
 
-You can either let autobrr create the config itself at startup, or create one manually. For more information, please visit [configuring autobrr](/configuration/autobrr) which covers creating a user manually, configuring the default port, setting the desired log level, etc.
+You can either let autobrr create the config itself at startup, or create one manually. For more information, please visit [configuring autobrr](../configuration/autobrr) which covers creating a user manually, configuring the default port, setting the desired log level, etc.
 
 ### Systemd (recommended)
 
diff --git a/docs/installation/shared-seedbox.md b/docs/installation/shared-seedbox.md
@@ -43,10 +43,10 @@ These are instructions and installation scripts for shared seedboxes. We have su
 
 The scripts requires some input but does most of the work.
 
-Additionally see our installation instructions for [Linux <FaLinux />](/installation/linux), [Docker <FaDocker />](/installation/docker) and [Windows <FaWindows />](/installation/windows).
+Additionally see our installation instructions for [Linux <FaLinux />](../installation/linux.md), [Docker <FaDocker />](../installation/docker.md) and [Windows <FaWindows />](../installation/windows.md).
 
 import SeedboxInstallers from '/snippets/seedbox-installers.mdx';
 
 <SeedboxInstallers />
 
-Note: Remember to head over to our [Configuration Guide](/configuration/indexers) to learn how to set up your indexers, IRC, and download clients after you're done installing.
+Note: Remember to head over to our [Configuration Guide](../configuration/indexers.md) to learn how to set up your indexers, IRC, and download clients after you're done installing.
diff --git a/docs/installation/supplementary/transfer-installation.md b/docs/installation/supplementary/transfer-installation.md
@@ -38,10 +38,10 @@ Now that you have successfully backed up your `autobrr.db` from your old host, y
 
 Please refer to our guides or to the guides of your hosting provider on how to install autobrr on you new host:
 
-- [Linux](/installation/linux)
-- [Docker](/installation/docker)
-- [Shared Seedbox](/installation/shared-seedbox)
-- [Windows](/installation/windows)
+- [Linux](../linux.md)
+- [Docker](../docker.md)
+- [Shared Seedbox](../shared-seedbox.md)
+- [Windows](../windows.md)
 
 ## Restoring your database
 
diff --git a/docs/installation/windows.md b/docs/installation/windows.md
@@ -25,7 +25,7 @@ https://github.com/autobrr/autobrr/releases/latest
 
 ### Manually configure autobrr (optional) {#manually-configure-autobrr}
 
-You can either let autobrr create the config itself at startup, or create one manually. For more information, please visit [configuring autobrr](/configuration/autobrr) which covers creating a user manually, configuring the default port, setting the desired log level, etc.
+You can either let autobrr create the config itself at startup, or create one manually. For more information, please visit [configuring autobrr](../configuration/autobrr.md) which covers creating a user manually, configuring the default port, setting the desired log level, etc.
 
 ## Create Windows task
 
diff --git a/docs/introduction.md b/docs/introduction.md
diff --git a/docs/quick-start.md b/docs/quick-start.md
diff --git a/docs/usage/search.md b/docs/usage/search.md
diff --git a/docs/usage/tips.md b/docs/usage/tips.md
diff --git a/docusaurus.config.js b/docusaurus.config.js
diff --git a/package.json b/package.json
diff --git a/versions.json b/versions.json
diff --git a/yarn.lock b/yarn.lock
