Skip to content

Commit

Permalink
Remove all documentation related to Sonarr v3
Browse files Browse the repository at this point in the history
Starting with Recyclarr v7.0, Sonarr v3 support will be removed.
  • Loading branch information
rcdailey committed Mar 24, 2024
1 parent 2d97fd2 commit bbfd2d5
Show file tree
Hide file tree
Showing 17 changed files with 165 additions and 440 deletions.
19 changes: 0 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,25 +88,6 @@ that needs to be hard-wrapped and press `ALT+Q`.

[Rewrap]: https://marketplace.visualstudio.com/items?itemName=stkb.rewrap

### Version Requirements

When documenting features, especially when that feature has not been released yet, it's important to
call out specific version requirements. There's almost always a minimum version requirement.

Using the `:::note` admonition, follow the example below to point out the minimum version required.
Typically this should be done at the top of a section under a heading or page that describes the
feature.

Example:

```md
:::note Version Requirement

This functionality requires `v3.0.0` or greater!

:::
```

### Admonitions

Admonitions are the colored sections of text in the guide (Info, Caution, etc). Docusaurus documents
Expand Down
1 change: 0 additions & 1 deletion docs/behavior/include.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,6 @@ semantics, those will be documented in later sections. This will especially be t
| `quality_definition` | Mapping | Union |
| `delete_old_custom_formats` | Scalar | Replace |
| `replace_existing_custom_formats` | Scalar | Replace |
| `release_profiles` | Sequence | Add |
| `media_naming` | Mapping | Union |

### Quality Definition {#quality-definition}
Expand Down
20 changes: 0 additions & 20 deletions docs/behavior/release-profiles.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/cli/list/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,5 @@ Provides a series of commands used to list information in the guide.
## Commands

- [recyclarr list custom-formats](list-custom-formats.md)
- [recyclarr list release-profiles](list-release-profiles.md)
- [recyclarr list qualities](list-qualities.md)
- [recyclarr list naming](list-naming.md)
96 changes: 0 additions & 96 deletions docs/cli/list/list-release-profiles.md

This file was deleted.

53 changes: 5 additions & 48 deletions docs/cli/sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,55 +66,12 @@ recyclarr sync -c ../myconfig1.yml -c "files/my config 2.yml"

### `-p|--preview` {#preview}

Performs a "dry run" by parsing the guide and printing the parsed data in a readable format to the
user. This does *not* perform any API calls to Radarr or Sonarr. You may want to run a preview if
you'd like to see if the guide is parsed correctly and preview changes that will be made before
updating your instance.
Instructs Recyclarr to perform all the work it normally would do during a sync, except it won't
update your actual instance configuration. This gives you the opportunity to see what Recyclarr
would do without actually committing those changes.

Example output for Sonarr Release Profile parsing

```txt
First Release Profile
Include Preferred when Renaming?
CHECKED
Must Not Contain:
/(\[EMBER\]|-EMBER\b|DaddySubs)/i
Preferred:
100 /\b(amzn|amazon)\b(?=[ ._-]web[ ._-]?(dl|rip)\b)/i
90 /\b(dsnp|dsny|disney)\b(?=[ ._-]web[ ._-]?(dl|rip)\b)/i
Second Release Profile
Include Preferred when Renaming?
NOT CHECKED
Preferred:
180 /(-deflate|-inflate)\b/i
150 /(-AJP69|-BTN|-CasStudio|-CtrlHD|-KiNGS)\b/i
150 /(-monkee|-NTb|-NTG|-QOQ|-RTN)\b/i
```

Example output for Sonarr Quality Definition parsing

```txt
Quality Min Max
------- --- ---
HDTV-720p 2.3 67.5
HDTV-1080p 2.3 137.3
WEBRip-720p 4.3 137.3
WEBDL-720p 4.3 137.3
Bluray-720p 4.3 137.3
WEBRip-1080p 4.5 257.4
WEBDL-1080p 4.3 253.6
Bluray-1080p 4.3 258.1
Bluray-1080p Remux 0 400
HDTV-2160p 69.1 350
WEBRip-2160p 69.1 350
WEBDL-2160p 69.1 350
Bluray-2160p 94.6 400
Bluray-2160p Remux 204.4 400
```
Note that, in this mode, Recyclarr will still make API calls to services but only to *fetch* data;
it will never invoke the API to make actual changes.

### `-i|--instance` {#instance}

Expand Down
55 changes: 25 additions & 30 deletions docs/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,65 +4,60 @@ title: Features
sidebar_position: 2
---

## Compatibility

Recyclarr is compatible with the following services and versions.

| Service | Minimum Version |
| ------- | --------------- |
| Sonarr | `v4.0.0` |
| Radarr | `v3.0.0` |

:::info

Sonarr v3 is no longer supported by Recyclarr starting with version v7.0!

:::

## Supported Features

A comprehensive list of features in Recyclarr.

## Custom Formats
### Custom Formats

- A user-specified list of custom formats are synchronized to Sonarr from the TRaSH guides.
- Scores from the guides can be synchronized to quality profiles of your choosing.
- User can specify their own scores for custom formats (instead of using the guide score).
- Option to enable automatic deletion custom formats in Sonarr when they are removed from config or
the guide.

## Quality Profiles
### Quality Profiles

- Create and modify quality profiles.
- Compatible with Sonarr v3.
- Sync profile fields: "Upgrade Allowed", "Upgrade Until Custom Format Score", "Upgrade Until
Quality", "Minimum Custom Format Score".
- Sync Qualities and Quality Groups.
- Option to choose multiple sort algorithms for qualities.

## Quality Definitions
### Quality Definitions

- Guide-provided quality definitions, such as Anime, Series (Non-Anime), and Movies.

## Release Profiles

:::info

Sonarr v3 Only

:::

- "Preferred", "Must Not Contain", and "Must Contain" terms from guides are reflected in
corresponding release profile fields in Sonarr.
- "Include Preferred when Renaming" is properly checked/unchecked depending on explicit mention of
this in the guides.
- Release Profiles get created if they do not exist, or updated if they already exist.
- Tags can be added to any updated or created profiles. Tags are created for you if they do not
exist.
- Ability to convert preferred with negative scores to "Must not contain" terms.
- Terms mentioned as "optional" in the guide can be selectively included or excluded; based entirely
on user preference.
- Convenient command line options to get information from the guide to more easily add it to your
YAML configuration.

## Media Naming
### Media Naming

- Sync media naming formats from the guides, such as file and folder naming.
- Ability to exclude sync for specific naming formats to manage them manually.
- Preview functionality to show what will be synced before doing it.

## Command Line Operations
### Command Line Operations

- A `list` command for showing available custom formats, release profiles, media naming formats, and
quality definitions available in the TRaSH Guides.
- A `list` command for showing available custom formats, media naming formats, and quality
definitions available in the TRaSH Guides.
- A `delete` command providing ways to delete stuff from Radarr & Sonarr, such as custom formats.
- A `config` command for managing configuration YAML files, including creating new configuration
files from pre-made templates.

## YAML Features
### YAML Features

- Use environment variables in your configuration via `!env_var`.
- Specify and store secret values (such as API keys) using `!secret`.
Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting/reporting-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ particular, the Base URL and API Key for each service you've configured. Typical
this information shared to others when you request help or file bug reports on Github. As such, you
should ensure that this information is redacted. You can do this in multiple ways.

- Use [secrets](/yaml/secrets-reference.md) (requires `v3.0` or higher)
- Use [secrets](/yaml/secrets-reference.md)
- Manually edit your YAML before sharing it to redact `base_url` and `api_key` values.

## Reporting Issues
Expand Down
1 change: 0 additions & 1 deletion docs/yaml/config-reference/basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ sidebar_position: 1

| Service | Supported |
| ----------- | :------------------------------------------------------: |
| Sonarr (v3) | <icon icon="mdi:check-bold" height="24" color="green" /> |
| Sonarr (v4) | <icon icon="mdi:check-bold" height="24" color="green" /> |
| Radarr | <icon icon="mdi:check-bold" height="24" color="green" /> |

Expand Down
1 change: 0 additions & 1 deletion docs/yaml/config-reference/custom-formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ sidebar_position: 2

| Service | Supported |
| ----------- | :------------------------------------------------------: |
| Sonarr (v3) | <icon icon="mdi:close-thick" height="24" color="red" /> |
| Sonarr (v4) | <icon icon="mdi:check-bold" height="24" color="green" /> |
| Radarr | <icon icon="mdi:check-bold" height="24" color="green" /> |

Expand Down
1 change: 0 additions & 1 deletion docs/yaml/config-reference/include.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ sidebar_position: 6

| Service | Supported |
| ----------- | :------------------------------------------------------: |
| Sonarr (v3) | <icon icon="mdi:check-bold" height="24" color="green" /> |
| Sonarr (v4) | <icon icon="mdi:check-bold" height="24" color="green" /> |
| Radarr | <icon icon="mdi:check-bold" height="24" color="green" /> |

Expand Down
1 change: 0 additions & 1 deletion docs/yaml/config-reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,5 @@ Add this comment to the top of your YAML file:
- [Custom Formats](custom-formats.md)
- [Quality Definition](quality-definition.md)
- [Quality Profiles](quality-profiles.md)
- [Release Profiles](release-profiles.md)
- [Include](include.md)
- [Media Naming](media-naming.md)
1 change: 0 additions & 1 deletion docs/yaml/config-reference/media-naming.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ sidebar_position: 7

| Service | Supported |
| ----------- | :------------------------------------------------------: |
| Sonarr (v3) | <icon icon="mdi:check-bold" height="24" color="green" /> |
| Sonarr (v4) | <icon icon="mdi:check-bold" height="24" color="green" /> |
| Radarr | <icon icon="mdi:check-bold" height="24" color="green" /> |

Expand Down
1 change: 0 additions & 1 deletion docs/yaml/config-reference/quality-definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ sidebar_position: 3

| Service | Supported |
| ----------- | :------------------------------------------------------: |
| Sonarr (v3) | <icon icon="mdi:check-bold" height="24" color="green" /> |
| Sonarr (v4) | <icon icon="mdi:check-bold" height="24" color="green" /> |
| Radarr | <icon icon="mdi:check-bold" height="24" color="green" /> |

Expand Down
Loading

0 comments on commit bbfd2d5

Please sign in to comment.