docs: restructure the docs

37 files changed, 117 insertions, 24 deletions

diff --git a/docs/docs/01-intro.md b/docs/docs/01-getting-started/01-intro.md
index 1c99f4c0..1c99f4c0 100644
--- a/docs/docs/01-intro.md
+++ b/docs/docs/01-getting-started/01-intro.md
diff --git a/docs/docs/04-screenshots.md b/docs/docs/01-getting-started/02-screenshots.md
index 07830566..07830566 100644
--- a/docs/docs/04-screenshots.md
+++ b/docs/docs/01-getting-started/02-screenshots.md
diff --git a/docs/docs/01-getting-started/_category_.json b/docs/docs/01-getting-started/_category_.json
new file mode 100644
index 00000000..41f4c00e
--- /dev/null
+++ b/docs/docs/01-getting-started/_category_.json
@@ -0,0 +1,3 @@
+{
+  "label": "Getting Started"
+}
diff --git a/docs/docs/02-installation/01-docker.md b/docs/docs/02-installation/01-docker.md
index ff508b73..1a89796c 100644
--- a/docs/docs/02-installation/01-docker.md
+++ b/docs/docs/02-installation/01-docker.md
@@ -44,7 +44,7 @@ Persistent storage and the wiring between the different services is already take
 
 Keep in mind that every time you change the `.env` file, you'll need to re-run `docker compose up`.
 
-If you want more config params, check the config documentation [here](/configuration).
+If you want more config params, check the config documentation [here](../configuration/environment-variables).
 
 ### 4. Setup OpenAI
 
@@ -57,7 +57,7 @@ To enable automatic tagging, you'll need to configure OpenAI. This is optional t
 OPENAI_API_KEY=<key>
 ```
 
-Learn more about the costs of using openai [here](/openai).
+Learn more about the costs of using openai [here](../integrations/openai).
 
 <details>
     <summary>If you want to use Ollama (https://ollama.com/) instead for local inference.</summary>
@@ -85,11 +85,11 @@ Then visit `http://localhost:3000` and you should be greeted with the Sign In pa
 
 ### [Optional] 6. Enable optional features
 
-Check the [configuration docs](/configuration) for extra features to enable such as full page archival, full page screenshots, inference languages, etc.
+Check the [configuration docs](../configuration/environment-variables) for extra features to enable such as full page archival, full page screenshots, inference languages, etc.
 
 ### [Optional] 7. Setup quick sharing extensions
 
-Go to the [quick sharing page](/quick-sharing) to install the mobile apps and the browser extensions. Those will help you hoard things faster!
+Go to the [quick sharing page](../using-karakeep/quick-sharing) to install the mobile apps and the browser extensions. Those will help you hoard things faster!
 
 ## Updating
 
@@ -98,4 +98,4 @@ Updating Karakeep will depend on what you used for the `KARAKEEP_VERSION` env va
 - If you pinned the app to a specific version, bump the version and re-run `docker compose up -d`. This should pull the new version for you.
 - If you used `KARAKEEP_VERSION=release`, you'll need to force docker to pull the latest version by running `docker compose up --pull always -d`.
 
-Note that if you want to upgrade/migrate `Meilisearch` versions, refer to the [troubleshooting](/troubleshooting) page.
+Note that if you want to upgrade/migrate `Meilisearch` versions, refer to the [troubleshooting](../administration/troubleshooting) page.
diff --git a/docs/docs/02-installation/03-archlinux.md b/docs/docs/02-installation/03-archlinux.md
index 63db9d75..b8433374 100644
--- a/docs/docs/02-installation/03-archlinux.md
+++ b/docs/docs/02-installation/03-archlinux.md
@@ -27,7 +27,7 @@
 
 3. Set up
 
-    Environment variables can be set in `/etc/karakeep/karakeep.env` according to [configuration page](/configuration). **The environment variables that are not specified in `/etc/karakeep/karakeep.env` need to be added by yourself.**
+    Environment variables can be set in `/etc/karakeep/karakeep.env` according to [configuration page](../configuration/environment-variables). **The environment variables that are not specified in `/etc/karakeep/karakeep.env` need to be added by yourself.**
 
 4. Enable service
 
@@ -82,7 +82,7 @@ sudo chown -R karakeep:karakeep /var/lib/karakeep
 ```
 
 **6. Set Karakeep**  
-Edit `/etc/karakeep/karakeep.env` according to [configuration page](/configuration). **The environment variables that are not specified in `/etc/karakeep/karakeep.env` need to be added by yourself.**
+Edit `/etc/karakeep/karakeep.env` according to [configuration page](../configuration/environment-variables). **The environment variables that are not specified in `/etc/karakeep/karakeep.env` need to be added by yourself.**
 
 Or you can copy old hoarder env file to karakeep:
 ```shell
diff --git a/docs/docs/02-installation/04-kubernetes.md b/docs/docs/02-installation/04-kubernetes.md
index b8c40551..b3a42d84 100644
--- a/docs/docs/02-installation/04-kubernetes.md
+++ b/docs/docs/02-installation/04-kubernetes.md
@@ -18,7 +18,7 @@ You should also change the `NEXTAUTH_URL` variable to point to your server addre
 
 Using `KARAKEEP_VERSION=release` will pull the latest stable version. You might want to pin the version instead to control the upgrades (e.g. `KARAKEEP_VERSION=0.10.0`). Check the latest versions [here](https://github.com/karakeep-app/karakeep/pkgs/container/karakeep).
 
-To see all available configuration options check the [documentation](https://docs.karakeep.app/configuration).
+To see all available configuration options check the [documentation](../configuration/environment-variables).
 
 To configure the neccessary secrets for the application copy the `.secrets_sample` file to `.secrets` and change the sample secrets to your generated secrets.
 
@@ -35,7 +35,7 @@ To enable automatic tagging, you'll need to configure OpenAI. This is optional t
 OPENAI_API_KEY=<key>
 ```
 
-Learn more about the costs of using openai [here](/openai).
+Learn more about the costs of using openai [here](../integrations/openai).
 
 <details>
     <summary>[EXPERIMENTAL] If you want to use Ollama (https://ollama.com/) instead for local inference.</summary>
@@ -103,7 +103,7 @@ If the secret is successfully created you can now configure the Ingress to use T
 
 ### [Optional] 6. Setup quick sharing extensions
 
-Go to the [quick sharing page](/quick-sharing) to install the mobile apps and the browser extensions. Those will help you hoard things faster!
+Go to the [quick sharing page](../using-karakeep/quick-sharing) to install the mobile apps and the browser extensions. Those will help you hoard things faster!
 
 ## Updating
 
diff --git a/docs/docs/02-installation/06-debuntu.md b/docs/docs/02-installation/06-debuntu.md
index 2f3d1113..55984728 100644
--- a/docs/docs/02-installation/06-debuntu.md
+++ b/docs/docs/02-installation/06-debuntu.md
@@ -71,4 +71,4 @@ During installation, the script created a configuration file for `meilisearch`,
 
 ## Still Running Hoarder?
 
-There is a way to upgrade. Please see [Guides > Hoarder to Karakeep Migration](https://docs.karakeep.app/Guides/hoarder-to-karakeep-migration)
+There is a way to upgrade. Please see [Hoarder to Karakeep Migration](../administration/hoarder-to-karakeep-migration)
diff --git a/docs/docs/02-installation/07-minimal-install.md b/docs/docs/02-installation/07-minimal-install.md
index 5c2ee399..e5720df1 100644
--- a/docs/docs/02-installation/07-minimal-install.md
+++ b/docs/docs/02-installation/07-minimal-install.md
@@ -44,6 +44,4 @@ docker run -d \
 You **MUST** change the `super_random_string` to a true random string which you can generate with `openssl rand -hex 32`.
 :::
 
-Check the [configuration docs](/configuration) for extra features to enable such as full page archival, full page screenshots, inference languages, etc.
-
-
+Check the [configuration docs](../configuration/environment-variables) for extra features to enable such as full page archival, full page screenshots, inference languages, etc.
diff --git a/docs/docs/03-configuration.md b/docs/docs/03-configuration/01-environment-variables.md
index b89460e6..ff9721e8 100644
--- a/docs/docs/03-configuration.md
+++ b/docs/docs/03-configuration/01-environment-variables.md
@@ -91,7 +91,7 @@ Either `OPENAI_API_KEY` or `OLLAMA_BASE_URL` need to be set for automatic taggin
 
 | Name                                 | Required | Default                | Description                                                                                                                                                                                                                                                                                                                                                                           |
 | ------------------------------------ | -------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| OPENAI_API_KEY                       | No       | Not set                | The OpenAI key used for automatic tagging. More on that in [here](/openai).                                                                                                                                                                                                                                                                                                           |
+| OPENAI_API_KEY                       | No       | Not set                | The OpenAI key used for automatic tagging. More on that in [here](../integrations/openai).                                                                                                                                                                                                                                                                                                           |
 | OPENAI_BASE_URL                      | No       | Not set                | If you just want to use OpenAI you don't need to pass this variable. If, however, you want to use some other openai compatible API (e.g. azure openai service), set this to the url of the API.                                                                                                                                                                                       |
 | OLLAMA_BASE_URL                      | No       | Not set                | If you want to use ollama for local inference, set the address of ollama API here.                                                                                                                                                                                                                                                                                                    |
 | OLLAMA_KEEP_ALIVE                    | No       | Not set                | Controls how long the model will stay loaded into memory following the request (example value: "5m").                                                                                                                                                                                                                                                                                 |
diff --git a/docs/docs/03-configuration/_category_.json b/docs/docs/03-configuration/_category_.json
new file mode 100644
index 00000000..78e56008
--- /dev/null
+++ b/docs/docs/03-configuration/_category_.json
@@ -0,0 +1,3 @@
+{
+  "label": "Configuration"
+}
diff --git a/docs/docs/05-quick-sharing.md b/docs/docs/04-using-karakeep/01-quick-sharing.md
index 254bec84..254bec84 100644
--- a/docs/docs/05-quick-sharing.md
+++ b/docs/docs/04-using-karakeep/01-quick-sharing.md
diff --git a/docs/docs/10-import.md b/docs/docs/04-using-karakeep/02-import.md
index 8ca8b1f9..4114ff79 100644
--- a/docs/docs/10-import.md
+++ b/docs/docs/04-using-karakeep/02-import.md
@@ -40,7 +40,7 @@ All the URLs in the bookmarks file will be added automatically, you will not be
 Importing bookmarks using the CLI requires some technical knowledge and might not be very straightforward for non-technical users. Don't hesitate to ask questions in github discussions or discord though.
 :::
 
-If you can get your bookmarks in a text file with one link per line, you can use the following command to import them using the [karakeep cli](https://docs.karakeep.app/command-line):
+If you can get your bookmarks in a text file with one link per line, you can use the following command to import them using the [karakeep cli](../integrations/command-line):
 
 ```
 while IFS= read -r url; do
diff --git a/docs/docs/14-guides/02-search-query-language.md b/docs/docs/04-using-karakeep/03-search-query-language.md
index 8f55ec2f..8f55ec2f 100644
--- a/docs/docs/14-guides/02-search-query-language.md
+++ b/docs/docs/04-using-karakeep/03-search-query-language.md
diff --git a/docs/docs/04-using-karakeep/_category_.json b/docs/docs/04-using-karakeep/_category_.json
new file mode 100644
index 00000000..96a7071a
--- /dev/null
+++ b/docs/docs/04-using-karakeep/_category_.json
@@ -0,0 +1,3 @@
+{
+  "label": "Using Karakeep"
+}
diff --git a/docs/docs/06-openai.md b/docs/docs/05-integrations/01-openai.md
index 32218da8..32218da8 100644
--- a/docs/docs/06-openai.md
+++ b/docs/docs/05-integrations/01-openai.md
diff --git a/docs/docs/09-command-line.md b/docs/docs/05-integrations/02-command-line.md
index c8b00696..c8b00696 100644
--- a/docs/docs/09-command-line.md
+++ b/docs/docs/05-integrations/02-command-line.md
diff --git a/docs/docs/09-mcp.md b/docs/docs/05-integrations/03-mcp.md
index 514332de..514332de 100644
--- a/docs/docs/09-mcp.md
+++ b/docs/docs/05-integrations/03-mcp.md
diff --git a/docs/docs/14-guides/05-different-ai-providers.md b/docs/docs/05-integrations/04-different-ai-providers.md
index 9a86e04f..9a86e04f 100644
--- a/docs/docs/14-guides/05-different-ai-providers.md
+++ b/docs/docs/05-integrations/04-different-ai-providers.md
diff --git a/docs/docs/14-guides/03-singlefile.md b/docs/docs/05-integrations/05-singlefile.md
index c0f4e174..c0f4e174 100644
--- a/docs/docs/14-guides/03-singlefile.md
+++ b/docs/docs/05-integrations/05-singlefile.md
diff --git a/docs/docs/05-integrations/_category_.json b/docs/docs/05-integrations/_category_.json
new file mode 100644
index 00000000..e37aa473
--- /dev/null
+++ b/docs/docs/05-integrations/_category_.json
@@ -0,0 +1,3 @@
+{
+  "label": "Integrations"
+}
diff --git a/docs/docs/08-security-considerations.md b/docs/docs/06-administration/01-security-considerations.md
index 5a295526..5a295526 100644
--- a/docs/docs/08-security-considerations.md
+++ b/docs/docs/06-administration/01-security-considerations.md
diff --git a/docs/docs/11-FAQ.md b/docs/docs/06-administration/02-FAQ.md
index e6f59801..e6f59801 100644
--- a/docs/docs/11-FAQ.md
+++ b/docs/docs/06-administration/02-FAQ.md
diff --git a/docs/docs/12-troubleshooting.md b/docs/docs/06-administration/03-troubleshooting.md
index 4072442b..4072442b 100644
--- a/docs/docs/12-troubleshooting.md
+++ b/docs/docs/06-administration/03-troubleshooting.md
diff --git a/docs/docs/14-guides/06-server-migration.md b/docs/docs/06-administration/04-server-migration.md
index 147ae1ec..147ae1ec 100644
--- a/docs/docs/14-guides/06-server-migration.md
+++ b/docs/docs/06-administration/04-server-migration.md
diff --git a/docs/docs/14-guides/01-legacy-container-upgrade.md b/docs/docs/06-administration/05-legacy-container-upgrade.md
index d95c1c1e..d95c1c1e 100644
--- a/docs/docs/14-guides/01-legacy-container-upgrade.md
+++ b/docs/docs/06-administration/05-legacy-container-upgrade.md
diff --git a/docs/docs/14-guides/04-hoarder-to-karakeep-migration.md b/docs/docs/06-administration/06-hoarder-to-karakeep-migration.md
index 289a091c..4e309408 100644
--- a/docs/docs/14-guides/04-hoarder-to-karakeep-migration.md
+++ b/docs/docs/06-administration/06-hoarder-to-karakeep-migration.md
@@ -19,7 +19,7 @@ You can also change the `HOARDER_VERSION` environment variable but if you do so
 
 ## Migrating a Baremetal Installation
 
-If you previously used the [Debian/Ubuntu install script](https://docs.karakeep.app/Installation/debuntu) to install Hoarder, there is an option to migrate your installation to Karakeep.
+If you previously used the [Debian/Ubuntu install script](../installation/debuntu) to install Hoarder, there is an option to migrate your installation to Karakeep.
 
 ```bash
 bash karakeep-linux.sh migrate
diff --git a/docs/docs/06-administration/_category_.json b/docs/docs/06-administration/_category_.json
new file mode 100644
index 00000000..5b581902
--- /dev/null
+++ b/docs/docs/06-administration/_category_.json
@@ -0,0 +1,3 @@
+{
+  "label": "Administration"
+}
diff --git a/docs/docs/13-community-projects.md b/docs/docs/07-community/01-community-projects.md
index 828d545f..828d545f 100644
--- a/docs/docs/13-community-projects.md
+++ b/docs/docs/07-community/01-community-projects.md
diff --git a/docs/docs/07-community/_category_.json b/docs/docs/07-community/_category_.json
new file mode 100644
index 00000000..b9240603
--- /dev/null
+++ b/docs/docs/07-community/_category_.json
@@ -0,0 +1,3 @@
+{
+  "label": "Community"
+}
diff --git a/docs/docs/07-development/01-setup.md b/docs/docs/08-development/01-setup.md
index 1c98a675..1c98a675 100644
--- a/docs/docs/07-development/01-setup.md
+++ b/docs/docs/08-development/01-setup.md
diff --git a/docs/docs/07-development/02-directories.md b/docs/docs/08-development/02-directories.md
index 712e86a1..712e86a1 100644
--- a/docs/docs/07-development/02-directories.md
+++ b/docs/docs/08-development/02-directories.md
diff --git a/docs/docs/07-development/03-database.md b/docs/docs/08-development/03-database.md
index d7a15b62..d7a15b62 100644
--- a/docs/docs/07-development/03-database.md
+++ b/docs/docs/08-development/03-database.md
diff --git a/docs/docs/07-development/04-architecture.md b/docs/docs/08-development/04-architecture.md
index 5a864034..5a864034 100644
--- a/docs/docs/07-development/04-architecture.md
+++ b/docs/docs/08-development/04-architecture.md
diff --git a/docs/docs/07-development/_category_.json b/docs/docs/08-development/_category_.json
index 73dd67ec..73dd67ec 100644
--- a/docs/docs/07-development/_category_.json
+++ b/docs/docs/08-development/_category_.json
diff --git a/docs/docs/14-guides/_category_.json b/docs/docs/14-guides/_category_.json
deleted file mode 100644
index 117f7f1b..00000000
--- a/docs/docs/14-guides/_category_.json
+++ /dev/null
@@ -1,3 +0,0 @@
-{
-    "label": "Guides",
-}
diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts
index 9de88d45..1ba393d1 100644
--- a/docs/docusaurus.config.ts
+++ b/docs/docusaurus.config.ts
@@ -19,7 +19,7 @@ const config: Config = {
   organizationName: "karakeep-app", // Usually your GitHub org/user name.
   projectName: "karakeep", // Usually your repo name.
 
-  onBrokenLinks: "throw",
+  onBrokenLinks: "warn",
   onBrokenMarkdownLinks: "warn",
 
   // Even if you don't use internationalization, you can use this field to set
@@ -58,6 +58,85 @@ const config: Config = {
   ],
   plugins: [
     [
+      "@docusaurus/plugin-client-redirects",
+      {
+      //   redirects: [
+      //     {
+      //       to: "/getting-started/intro",
+      //       from: "/intro",
+      //     },
+      //     {
+      //       to: "/getting-started/screenshots",
+      //       from: "/screenshots",
+      //     },
+      //     {
+      //       to: "/configuration/environment-variables",
+      //       from: "/configuration",
+      //     },
+      //     {
+      //       to: "/using-karakeep/quick-sharing",
+      //       from: "/quick-sharing",
+      //     },
+      //     {
+      //       to: "/using-karakeep/import",
+      //       from: "/import",
+      //     },
+      //     {
+      //       to: "/using-karakeep/search-query-language",
+      //       from: "/guides/search-query-language",
+      //     },
+      //     {
+      //       to: "/integrations/openai",
+      //       from: "/openai",
+      //     },
+      //     {
+      //       to: "/integrations/command-line",
+      //       from: "/command-line",
+      //     },
+      //     {
+      //       to: "/integrations/mcp",
+      //       from: "/mcp",
+      //     },
+      //     {
+      //       to: "/integrations/different-ai-providers",
+      //       from: "/guides/different-ai-providers",
+      //     },
+      //     {
+      //       to: "/integrations/singlefile",
+      //       from: "/guides/singlefile",
+      //     },
+      //     {
+      //       to: "/administration/security-considerations",
+      //       from: "/security-considerations",
+      //     },
+      //     {
+      //       to: "/administration/FAQ",
+      //       from: "/FAQ",
+      //     },
+      //     {
+      //       to: "/administration/troubleshooting",
+      //       from: "/troubleshooting",
+      //     },
+      //     {
+      //       to: "/administration/server-migration",
+      //       from: "/guides/server-migration",
+      //     },
+      //     {
+      //       to: "/administration/legacy-container-upgrade",
+      //       from: "/guides/legacy-container-upgrade",
+      //     },
+      //     {
+      //       to: "/administration/hoarder-to-karakeep-migration",
+      //       from: "/guides/hoarder-to-karakeep-migration",
+      //     },
+      //     {
+      //       to: "/community/community-projects",
+      //       from: "/community-projects",
+      //     },
+      //   ],
+      },
+    ],
+    [
       "docusaurus-plugin-openapi-docs",
       {
         id: "api",
@@ -110,10 +189,10 @@ const config: Config = {
     },
 
     algolia: {
-      appId: 'V93C1M14G6',
+      appId: "V93C1M14G6",
       // Public API key: it is safe to commit it
-      apiKey: '0eb8853d9740822fb9d21620d5515f35',
-      indexName: 'karakeep',
+      apiKey: "0eb8853d9740822fb9d21620d5515f35",
+      indexName: "karakeep",
       contextualSearch: true,
       insights: true,
     },
diff --git a/docs/package.json b/docs/package.json
index 06bc3ad5..e04dbda2 100644
--- a/docs/package.json
+++ b/docs/package.json
@@ -17,6 +17,7 @@
   },
   "dependencies": {
     "@docusaurus/core": "3.8.1",
+    "@docusaurus/plugin-client-redirects": "^3.8.1",
     "@docusaurus/preset-classic": "3.8.1",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.1.0",