GitBook: Update content

docs/README.md

@@ -0,0 +1,7 @@
+# API Reference
+
+!!! info
+    Media Manager's backend is built with FastAPI, which automatically generates interactive API documentation.
+
+* Swagger UI (typically available at `http://localhost:8000/docs`)
+* ReDoc (typically available at `http://localhost:8000/redoc`)

docs/SUMMARY.md

@@ -0,0 +1,30 @@
+# Table of contents
+
+* [API Reference](README.md)
+* [Importing existing media](importing-existing-media.md)
+* [index](index.md)
+* [Screenshots](screenshots.md)
+* [Troubleshooting](troubleshooting.md)
+* [advanced-features](advanced-features/README.md)
+  * [Custom port](advanced-features/custom-port.md)
+  * [Disable startup ascii art](advanced-features/disable-startup-ascii-art.md)
+  * [Follow symlinks in frontend files](advanced-features/follow-symlinks-in-frontend-files.md)
+  * [Metadata Provider Configuration](advanced-features/metadata-provider-configuration.md)
+  * [qBittorrent Category](advanced-features/qbittorrent-category.md)
+  * [URL Prefix](advanced-features/url-prefix.md)
+* [Configuration](configuration/README.md)
+  * [Authentication](configuration/authentication.md)
+  * [Backend](configuration/backend.md)
+  * [Custom Libraries](configuration/custom-libraries.md)
+  * [Database](configuration/database.md)
+  * [Download Clients](configuration/download-clients.md)
+  * [Indexers](configuration/indexers.md)
+  * [Logging](configuration/logging.md)
+  * [Notifications](configuration/notifications.md)
+  * [Scoring Rulesets](configuration/scoring-rulesets.md)
+* [contributing-to-mediamanager](contributing-to-mediamanager/README.md)
+  * [Developer Guide](contributing-to-mediamanager/developer-guide.md)
+  * [Documentation](contributing-to-mediamanager/documentation.md)
+* [Installation Guide](installation/README.md)
+  * [Docker Compose](installation/docker.md)
+  * [Nix Flakes](installation/flakes.md)

docs/advanced-features/README.md

@@ -0,0 +1,9 @@
+---
+description: >-
+  The features in this section are not required to run MediaManager and serve
+  their purpose in very specific environments, but they can enhance your
+  experience and provide additional functionality.
+---
+
+# advanced-features
+

docs/configuration/authentication.md

@@ -22,17 +22,13 @@ All authentication settings are configured in the `[auth]` section of your `conf
 * `registration_enabled`\
   Allows new users to sign up for an account. Default is `false`.
 
-!!! info
-    To use email password resets, you must also configure SMTP settings in the `[notifications.smtp_config]` section.
+!!! info To use email password resets, you must also configure SMTP settings in the `[notifications.smtp_config]` section.
 
-!!! info
-    When `registration_enabled` is `false`, the sign-up page is hidden, `/auth/register` returns 403, and OIDC rejects unknown users (existing users keep working). The bootstrap admin (see `admin_emails`) is unaffected.
+!!! info When `registration_enabled` is `false`, the sign-up page is hidden, `/auth/register` returns 403, and OIDC rejects unknown users (existing users keep working). The bootstrap admin (see `admin_emails`) is unaffected.
 
-!!! tip "Adding users when registration is disabled"
-    Administrators can add users at any time from the **Settings → Users** page via the "Add User" button. For OIDC-only users, leave the password field blank — a random password is generated and the user is matched to their OIDC account by email on first sign-in.
+!!! tip "Adding users when registration is disabled" Administrators can add users at any time from the **Settings → Users** page via the "Add User" button. For OIDC-only users, leave the password field blank — a random password is generated and the user is matched to their OIDC account by email on first sign-in.
 
-!!! info
-    When setting up MediaManager for the first time, you should add your email to `admin_emails` in the `[auth]` config section. MediaManager will then use this email instead of the default admin email. Your account will automatically be created as an admin account, allowing you to manage other users, media and settings.
+!!! info When setting up MediaManager for the first time, you should add your email to `admin_emails` in the `[auth]` config section. MediaManager will then use this email instead of the default admin email. Your account will automatically be created as an admin account, allowing you to manage other users, media and settings.
 
 ## OpenID Connect Settings (`[auth.openid_connect]`)
 
@@ -59,20 +55,19 @@ The OpenID server will likely require a redirect URI. This URL will usually look
 {MEDIAMANAGER_URL}/api/v1/auth/oauth/callback
 ```
 
-!!! warning
-    It is very important that you set the correct callback URI, otherwise it won't work!
+!!! warning It is very important that you set the correct callback URI, otherwise it won't work!
 
 #### Authentik Example
 
 Here is an example configuration for the OpenID Connect provider for Authentik.
 
-![authentik-redirect-url-example](<../assets/assets/authentik redirect url example.png>)
+![authentik-redirect-url-example](<../.gitbook/assets/authentik redirect url example.png>)
 
 ## Example Configuration
 
 Here's a complete example of the authentication section in your `config.toml`:
 
-```toml title="config.toml"
+```toml
 [auth]
 token_secret = "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6"
 session_lifetime = 604800  # 1 week
@@ -87,4 +82,3 @@ client_secret = "your-secret-key-here"
 configuration_endpoint = "https://auth.example.com/.well-known/openid-configuration"
 name = "Authentik"
 ```
-

docs/contributing-to-mediamanager/README.md

@@ -0,0 +1,2 @@
+# contributing-to-mediamanager
+

docs/screenshots.md

@@ -1,6 +1,5 @@
 # Screenshots
 
-!!! info
-    MediaManager also supports darkmode!
+!!! info MediaManager also supports darkmode!
 
-![screenshot-dashboard.png](<assets/assets/screenshot dashboard.png>) ![screenshot-tv-dashboard.png](<assets/assets/screenshot tv dashboard.png>) ![screenshot-download-season.png](<assets/assets/screenshot download season.png>) ![screenshot-request-season.png](<assets/assets/screenshot request season.png>) ![screenshot-tv-torrents.png](<assets/assets/screenshot tv torrents.png>) ![screenshot-settings.png](<assets/assets/screenshot settings.png>) ![screenshot-login.png](<assets/assets/screenshot login.png>)
+![screenshot-dashboard.png](<.gitbook/assets/screenshot dashboard.png>) ![screenshot-tv-dashboard.png](<.gitbook/assets/screenshot tv dashboard.png>) ![screenshot-download-season.png](<.gitbook/assets/screenshot download season.png>) ![screenshot-request-season.png](<.gitbook/assets/screenshot request season.png>) ![screenshot-tv-torrents.png](<.gitbook/assets/screenshot tv torrents.png>) ![screenshot-settings.png](<.gitbook/assets/screenshot settings.png>) ![screenshot-login.png](<.gitbook/assets/screenshot login.png>)

docs/troubleshooting.md

@@ -1,13 +1,12 @@
 # Troubleshooting
 
-!!! info
-    Always check the container and browser logs for more specific error messages
+!!! info Always check the container and browser logs for more specific error messages
 
 <details>
 
 <summary>Authentication Issues</summary>
 
-#### I can't log in with OAuth/OIDC?
+**I can't log in with OAuth/OIDC?**
 
 Verify provider configurationVerify your OAuth provider's configuration. See the OAuth documentationCheck callback URICheck if the callback URI you set in your OIDC providers settings is correct. See the callback URI documentationCheck frontend URLCheck the frontend url in your config file. It should match the URL you use to access MediaManager.
 
@@ -35,7 +34,7 @@ The reason is that hard linking only works within the same filesystem. If your d
 
 <summary>Torrent Search Issues</summary>
 
-#### I get no search results for torrents?
+**I get no search results for torrents?**
 
 Switch to advanced tabTry switching to the advanced tab when searching for torrents.Increase timeout for slow indexersIf you use "slow" indexers, try increasing the timeout threshold.Check logsIf you still don't get any search results, check the logs, they will provide more information on what is going wrong.
 
@@ -56,12 +55,11 @@ Switch to advanced tabTry switching to the advanced tab when searching for torre
 * If you get a 401 or 403 error when pulling the image from GHCR, this is not a permission issue with the repository/image. It errors because your Docker client is misconfigured.
 * This is not a MediaManager issue per se, so please don't open an issue about this on the MediaManager GitHub repo.
 
-#### Possible Fixes:
+**Possible Fixes:**
 
 * [Unable to pull image from GitHub Container Registry (Stack Overflow)](https://stackoverflow.com/questions/74656167/unable-to-pull-image-from-github-container-registry-ghcr)
 * [Try pulling the image from Quay.io](installation/docker.md#docker-images)
 
 </details>
 
-!!! info
-    If it still doesn't work, [please open an Issue.](https://github.com/maxdorninger/MediaManager/issues) It is possible that a bug is causing the issue.
+!!! info If it still doesn't work, [please open an Issue.](https://github.com/maxdorninger/MediaManager/issues) It is possible that a bug is causing the issue.