Merge pull request #147 from raydak-labs/docs/comp

raydak-labs · Jan 10, 2025 · b460963 · b460963
2 parents d446205 + 84077f8
commit b460963
Show file tree

Hide file tree

Showing 6 changed files with 84 additions and 4 deletions.
diff --git a/docs/docs/comparison.mdx b/docs/docs/comparison.mdx
@@ -0,0 +1,75 @@
+---
+sidebar_position: 7
+description: "Comparison of Configarr to other tools"
+keywords: [comparison, recyclarr, notifiarr]
+---
+
+# Comparison
+
+As Configarr is not the only tool around we will compare different tools based on feature sets in this sections.
+The main focus of Configarr is the full support of TRaSH-Guide and combine it with maximum customizability by the user.
+That's also the most mentionable contrast to all other tools which do not provide this flexibility as shown in the matrix.
+Focused together for seamless experience in containerized environments with docker and kubernetes.
+
+Notes:
+
+- TRaSH-Guide prefix means that we support the TRaSH-Guide provided JSON files in the repository [Repo](https://github.com/TRaSH-Guides/Guides/tree/master/docs/json)
+- Custom prefix means that you can create own e.q. custom formats in the tools which are not defined in TRaSH or somewhere. The user can do it directly with the tool in the config.
+
+## Radarr
+
+| Features                         | <div class="configarrHeader">Configarr</div> |     Notifiarr      |     Recyclarr      |
+| -------------------------------- | :------------------------------------------: | :----------------: | :----------------: |
+| GUI (graphical user interface)   |                                              | :white_check_mark: |                    |
+| TRaSH-Guide Custom Formats       |              :white_check_mark:              | :white_check_mark: | :white_check_mark: |
+| TRaSH-Guide Custom Format Groups |                                              | :white_check_mark: |                    |
+| TRaSH-Guide Quality Profiles     |              :white_check_mark:              | :white_check_mark: |                    |
+| TRaSH-Guide Quality Sizes        |              :white_check_mark:              | :white_check_mark: | :white_check_mark: |
+| TRaSH-Guide Naming               |              :white_check_mark:              | :white_check_mark: | :white_check_mark: |
+| Custom Custom Formats            |              :white_check_mark:              |                    |                    |
+| Custom Quality Profiles          |              :white_check_mark:              |                    | :white_check_mark: |
+| Custom Quality Sizes             |                                              |                    |                    |
+| Custom Naming                    |              :white_check_mark:              |                    |                    |
+| Clear all Custom Formats         |              :white_check_mark:              | :white_check_mark: | :white_check_mark: |
+| Modify Scores                    |              :white_check_mark:              | :white_check_mark: | :white_check_mark: |
+
+## Sonarr
+
+| Features                         | <div class="configarrHeader">Configarr</div> |     Notifiarr      |     Recyclarr      |
+| -------------------------------- | :------------------------------------------: | :----------------: | :----------------: |
+| GUI (graphical user interface)   |                                              | :white_check_mark: |                    |
+| TRaSH-Guide Custom Formats       |              :white_check_mark:              | :white_check_mark: | :white_check_mark: |
+| TRaSH-Guide Custom Format Groups |                                              | :white_check_mark: |                    |
+| TRaSH-Guide Quality Profiles     |              :white_check_mark:              | :white_check_mark: |                    |
+| TRaSH-Guide Quality Sizes        |              :white_check_mark:              | :white_check_mark: | :white_check_mark: |
+| TRaSH-Guide Naming               |              :white_check_mark:              | :white_check_mark: | :white_check_mark: |
+| Custom Custom Formats            |              :white_check_mark:              |                    |                    |
+| Custom Quality Profiles          |              :white_check_mark:              |                    | :white_check_mark: |
+| Custom Quality Sizes             |                                              |                    |                    |
+| Custom Naming                    |              :white_check_mark:              |                    |                    |
+| Clear all Custom Formats         |              :white_check_mark:              | :white_check_mark: | :white_check_mark: |
+| Modify Scores                    |              :white_check_mark:              | :white_check_mark: | :white_check_mark: |
+
+## Whisparr
+
+| Features                       | <div class="configarrHeader">Configarr</div> | Notifiarr (unsupported) | Recyclarr (unsupported) |
+| ------------------------------ | :------------------------------------------: | :---------------------: | :---------------------: |
+| GUI (graphical user interface) |                                              |                         |                         |
+| Custom Custom Formats          |              :white_check_mark:              |                         |                         |
+| Custom Quality Profiles        |              :white_check_mark:              |                         |                         |
+| Custom Quality Sizes           |                                              |                         |                         |
+| Custom Naming                  |              :white_check_mark:              |                         |                         |
+| Clear all Custom Formats       |              :white_check_mark:              |                         |                         |
+| Modify Scores                  |              :white_check_mark:              |                         |                         |
+
+## Readarr
+
+| Features                       | <div class="configarrHeader">Configarr</div> | Notifiarr (unsupported) | Recyclarr (unsupported) |
+| ------------------------------ | :------------------------------------------: | :---------------------: | :---------------------: |
+| GUI (graphical user interface) |                                              |                         |                         |
+| Custom Custom Formats          |              :white_check_mark:              |                         |                         |
+| Custom Quality Profiles        |              :white_check_mark:              |                         |                         |
+| Custom Quality Sizes           |                                              |                         |                         |
+| Custom Naming                  |              :white_check_mark:              |                         |                         |
+| Clear all Custom Formats       |              :white_check_mark:              |                         |                         |
+| Modify Scores                  |              :white_check_mark:              |                         |                         |
diff --git a/docs/docs/configuration/_category_.json b/docs/docs/configuration/_category_.json
@@ -1,6 +1,6 @@
 {
   "label": "Configuration",
-  "position": 3,
+  "position": 4,
   "link": {
     "type": "generated-index"
   }

diff --git a/docs/docs/examples.md b/docs/docs/examples.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 6
 description: "Examples of Configarr usage and configuration"
 keywords: [configarr, examples, configuration, sonarr, radarr]
 ---

diff --git a/docs/docs/installation/_category_.json b/docs/docs/installation/_category_.json
@@ -1,6 +1,6 @@
 {
   "label": "Installation",
-  "position": 2,
+  "position": 3,
   "link": {
     "type": "generated-index",
     "description": "Learn how to install Configarr"

diff --git a/docs/docs/profiles/index.mdx b/docs/docs/profiles/index.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 5
 description: "Sample profiles"
 keywords: [configarr, examples, configuration, profiles]
 ---

diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css
@@ -28,3 +28,8 @@
   --ifm-color-primary-lightest: #4fddbf;
   --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
 }
+
+.configarrHeader {
+  font-size: 18px;
+  font-weight: bolder;
+}