From 21f92b4a65984802f6398c81accc43484053e9a4 Mon Sep 17 00:00:00 2001
From: Jens Langhammer <jens.langhammer@beryju.org>
Date: Wed, 6 Apr 2022 00:06:28 +0200
Subject: [PATCH] website/docs: add docs for customisation

Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
---
 .../docs/interfaces/admin/customization.md    |  5 ++
 website/docs/interfaces/user/customization.md | 52 +++++++++++++++++++
 website/sidebars.js                           | 20 +++++++
 3 files changed, 77 insertions(+)
 create mode 100644 website/docs/interfaces/admin/customization.md
 create mode 100644 website/docs/interfaces/user/customization.md

diff --git a/website/docs/interfaces/admin/customization.md b/website/docs/interfaces/admin/customization.md
new file mode 100644
index 000000000..239082269
--- /dev/null
+++ b/website/docs/interfaces/admin/customization.md
@@ -0,0 +1,5 @@
+# Customization
+
+### `settings.pagination.perPage`
+
+How many items should be retrieved per page. Defaults to 20.
diff --git a/website/docs/interfaces/user/customization.md b/website/docs/interfaces/user/customization.md
new file mode 100644
index 000000000..627c51e45
--- /dev/null
+++ b/website/docs/interfaces/user/customization.md
@@ -0,0 +1,52 @@
+# Customization
+
+The user interface can be customized through attributes, and will be inherited from a users' groups.
+
+## Enabling/disabling features
+
+The following features can be enabled/disabled. By default, all of them are enabled:
+
+- `settings.enabledFeatures.apiDrawer`
+
+    API Request drawer in navbar
+- `settings.enabledFeatures.notificationDrawer`
+
+    Notification drawer in navbar
+- `settings.enabledFeatures.settings`
+
+    Settings link in navbar
+- `settings.enabledFeatures.applicationEdit`
+
+    Application edit in library (only shown when user is superuser)
+- `settings.enabledFeatures.search`
+
+    Search bar
+
+## Other configuration
+
+### `settings.navbar.userDisplay`
+
+Configure what is shown in the top right corner. Defaults to `username`. Choices: `username`, `name`, `email`
+
+### `settings.theme.background`
+
+Optional CSS which is applied in the background of the background of the user interface; for example
+
+```yaml
+settings:
+  theme:
+    background: >
+      background: url('https://picsum.photos/1920/1080');
+      filter: blur(8px);
+      background-position: center;
+      background-repeat: no-repeat;
+      background-size: cover;
+```
+
+### `settings.layout.type`
+
+Which layout to use for the Library view. Defaults to `row`. Choices: `row`, `2-column`, `3-column`
+
+### `settings.locale`
+
+The locale which can be configured in the user settings by default. This can be used to preset locales for groups of users, but still let them choose their own preferred locale
diff --git a/website/sidebars.js b/website/sidebars.js
index a86c798d8..0639a4b65 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -139,6 +139,26 @@ module.exports = {
                 "events/transports",
             ],
         },
+        {
+            type: "category",
+            label: "Interfaces",
+            items: [
+                {
+                    type: "category",
+                    label: "User",
+                    items: [
+                        "interfaces/user/customization",
+                    ],
+                },
+                {
+                    type: "category",
+                    label: "Admin",
+                    items: [
+                        "interfaces/admin/customization",
+                    ],
+                },
+            ],
+        },
         {
             type: "category",
             label: "Users & Groups",