feat: add content docs

Author: dreulavelle

docs/contribute.md

@@ -0,0 +1,66 @@
+# Contributing to Documentation
+
+Thank you for considering contributing to Riven Media! We welcome contributions from the community to help improve and expand the project. This guide will help you get started with the process of contributing.
+
+## Table of Contents
+1. [How to Contribute](#how-to-contribute)
+2. [Setting Up Your Development Environment](#setting-up-your-development-environment)
+3. [Submitting Changes](#submitting-changes)
+4. [Community](#community)
+
+---
+
+## How to Contribute
+
+### Reporting Bugs
+
+If you find a bug, please report it by creating an issue on our [GitHub repository](https://github.com/rivenmedia/wiki/issues). Provide as much detail as possible, including steps to reproduce the issue and any relevant logs or screenshots.
+
+### Suggesting Features
+
+We welcome feature suggestions! To suggest a new feature, please create an issue on our [GitHub repository](https://github.com/rivenmedia/wiki/issues) and describe your idea in detail. Include any potential use cases and benefits of the feature.
+
+### Contributing Code
+
+1. Fork the repository on GitHub.
+2. Create a new branch for your feature or bugfix.
+3. Write clear and concise commit messages.
+4. Ensure your code follows the project's coding standards and passes all tests.
+5. Submit a pull request to the `main` branch.
+
+## Setting Up Your Development Environment
+
+To set up your development environment, follow these steps:
+
+1. Clone the repository:
+    ```md
+    git clone https://github.com/rivenmedia/wiki riven-wiki && cd riven-wiki
+    ```
+
+2. Install the required dependencies:
+    ```md
+    poetry install
+    ```
+
+3. Start the development server:
+    ```md
+    mkdocs serve -a 0.0.0.0:8282
+    ```
+
+!!! note "Alternatively.."
+    You can also use `make install` to install the dependencies, followed by `make serve` to start the development server.
+
+## Submitting Changes
+
+When submitting changes, please ensure the following:
+
+1. Your commit messages follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
+2. Your pull request includes a clear description of the changes and the related issue (if applicable).
+
+---
+
+## Community
+
+Join our community on [Discord](https://discord.gg/rivenmedia) to discuss the project, ask questions, and collaborate with other contributors.
+
+Thank you for your contributions!

images/image.png renamed to docs/images/logo.png

@@ -85,10 +85,11 @@ Whether you're a casual viewer or a media enthusiast, Riven offers a powerful, a
 Before installing Riven, ensure you have the following prerequisites:
 
 !!! note
-    * **Linux**: Riven only supports Linux-based operating systems and Windows Subsystem for Linux (WSL) in Windows.
-    * **Rclone**: Required to mount debrid service. Additionally, Zurg is preferred for Real-Debrid users. [Learn more](/docs/rclone)
-    * **Media Server**: Currently only Plex Media Server is supported.
-    * **Docker**: Required to run Riven in a containerized environment. [Learn more](/docs/docker)
+    * **Linux**: Riven only supports Linux-based operating systems.
+    * **Windows**: Riven only supports Windows Subsystem for Linux (WSL) in Windows.
+    * **Rclone**: Required to mount debrid service. Additionally, Zurg is preferred for Real-Debrid users. [Learn more](https://rclone.org/)
+    * **Media Server**: Plex, Jellyfin, and Emby are supported.
+    * **Docker**: Required to run Riven in a containerized environment. [Learn more](https://www.docker.com/)
 
 !!! warning "Debrid Support"
     Currently only **Real-Debrid**, **All-Debrid** and **Torbox** are supported. More
@@ -229,37 +230,47 @@ This command will start the Riven services in the background. You can access the
 
 Once Riven is running, you can configure it by accessing the web interface. You will be prompted with onboarding steps to set up your debrid service, media server, content services and scraper services.
 
-There are 4 steps in the onboarding process:
+There are 4 steps in the onboarding process.
 
-### General Settings
+---
+
+### Step 1: General Settings
 
 In this step you configure the downloaders (debrid services), rclone mount path, library path, subtitles, etc. See the image below for an example.
 
-![step-1](/images/onboard/step1.png)
+![step-1](images/onboard/step1.png)
 
-### Media Server
+---
+
+### Step 2: Media Server
 
 In this step you configure the media server and updater settings. See the image below for an example.
 
-![step-2](/images/onboard/step2.png)
+![step-2](images/onboard/step2.png)
 
-### Content Services
+---
+
+### Step 3: Content Services
 
 In this step you configure the content services like trakt, overseerr, etc. See the image below for an example.
 
-![step-3](/images/onboard/step3.png)
+![step-3](images/onboard/step3.png)
+
+---
 
-### Scraper Services
+### Step 4: Scraper Services
 
 In this step you configure the scraper services like torrentio, zilean, prowlarr, jackett, etc. See the image below for an example.
 
-![step-4](/images/onboard/step4.png)
+![step-4](images/onboard/step4.png)
 
 ---
 
+### Done!
+
 Once you have completed the onboarding process, you will be greeted with a beautiful dashboard where you can manage your media library, request items, settings and many more in the future.
 
-![step-5](/images/onboard/final.png)
+![step-5](images/onboard/final.png)
 
 ---
 

images/onboard/final.png renamed to docs/images/onboard/final.png

@@ -0,0 +1,106 @@
+Riven supports various content services to help you manage and update your media library. Below is a list of the supported services, their configuration options, and examples of what to enter for each field.
+
+### Available Services
+
+- [Overseerr](#overseerr)
+- [Plex Watchlist](#plex-watchlist)
+- [Mdblist](#mdblist)
+- [Listrr](#listrr)
+- [Trakt](#trakt)
+
+!!! note "Lists support multiple values"
+    Some settings have lists that support multiple values. These are noted in the description of the setting.
+
+    - Example: `["value1", "value2"]`
+
+---
+
+## **Overseerr**
+
+Overseerr is a request management and media discovery tool. It helps you manage requests for your media library.
+
+- **enabled** (boolean): Boolean value to enable or disable the service. Default is true.
+    - Example: `true`
+- **update_interval** (integer): The interval in seconds at which the service will check for updates. Default is 60 seconds.
+    - Example: `60`
+- **url** (string): The URL of your Overseerr instance. Default is "http://localhost:5055".
+    - Example: `"http://localhost:5055"`
+- **api_key** (string): The API key for accessing Overseerr.
+    - Example: `"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"`
+- **use_webhook** (boolean): Boolean value to enable or disable the use of webhooks. Default is true.
+    - Example: `true`
+
+---
+
+## **Plex Watchlist**
+
+Plex Watchlist allows you to keep track of your desired media content.
+
+- **enabled** (boolean): Boolean value to enable or disable the service. Default is true.
+    - Example: `true`
+- **update_interval** (integer): The interval in seconds at which the service will check for updates. Default is 60 seconds.
+    - Example: `60`
+- **rss** (list of strings): A list of RSS feed URLs for your Plex Watchlist.
+    - Example: `["https://rss.plex.tv/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"]`
+
+---
+
+## **Mdblist**
+
+Mdblist is a service that provides curated lists of media content.
+
+- **enabled** (boolean): Boolean value to enable or disable the service. Default is false.
+    - Example: `false`
+- **update_interval** (integer): The interval in seconds at which the service will check for updates. Default is 300 seconds.
+    - Example: `300`
+- **api_key** (string): The API key for accessing Mdblist.
+    - Example: `"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"`
+- **lists** (list of strings): A list of Mdblist URLs for curated media lists.
+    - Example: `["https://mdblist.com/lists/xxxxxxx/xxxxxxxxxx"]`
+
+!!! note "lists also accept a list of ids"
+    - Example: `["123456", "654321"]`
+
+---
+
+## **Listrr**
+
+Listrr is a service for managing movie and show lists.
+
+- **enabled** (boolean): Boolean value to enable or disable the service. Default is false.
+    - Example: `false`
+- **update_interval** (integer): The interval in seconds at which the service will check for updates. Default is 300 seconds.
+    - Example: `300`
+- **movie_lists** (list of ints): A list of IDs for movie lists.
+    - Example: `[123456, 789012]`
+- **show_lists** (list of ints): A list of IDs for show lists.
+    - Example: `[345678, 901234]`
+- **api_key** (string): The API key for accessing Listrr.
+    - Example: `"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"`
+
+---
+
+## **Trakt**
+
+Trakt is a service that helps you keep track of what you're watching and discover new content.
+
+- **enabled** (boolean): Boolean value to enable or disable the service. Default is false.
+    - Example: `false`
+- **update_interval** (integer): The interval in seconds at which the service will check for updates. Default is 60 seconds.
+    - Example: `60`
+- **api_key** (string): The API key for accessing Trakt.
+    - Example: `"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"`
+- **watchlist** (list of strings): A list of Trakt usernames.
+    - Example: `["username1", "username2"]`
+- **user_lists** (list of strings): A list of Trakt user list URLs.
+    - Example: `["https://trakt.tv/users/username/lists/xxxxxxxx"]`
+- **collection** (list of strings): A list of Trakt collection usernames.
+    - Example: `["username1", "username2"]`
+- **fetch_trending** (boolean): Boolean value to enable or disable fetching trending content. Default is true.
+    - Example: `true`
+- **trending_count** (integer): The number of trending items to fetch. Default is 10.
+    - Example: `10`
+- **fetch_popular** (boolean): Boolean value to enable or disable fetching popular content. Default is true.
+    - Example: `true`
+- **popular_count** (integer): The number of popular items to fetch. Default is 10.
+    - Example: `10`

images/onboard/step1.png renamed to docs/images/onboard/step1.png

@@ -0,0 +1 @@
+Coming soon!