diff --git a/wiki/Behavior.md b/wiki/Behavior.md new file mode 100644 index 00000000..765c3975 --- /dev/null +++ b/wiki/Behavior.md @@ -0,0 +1,22 @@ +Special notes about behavior of Trash Updater with regards to the various services it supports will +be documented here. + +# Sonarr + +Each section below represents a topic covering certain behavior relevant to Sonarr. + +## Release Profile Naming + +The script procedurally generates a name for release profiles it creates. For the following example: + +```txt +[Trash] Anime - First Release Profile +``` + +The name is generated as follows: + +- `[Trash]` is added by Trash Updater to indicate that this Release Profile is created and managed + by it. This prefix exists to separate it from any Release Profiles the user may have manually + created (which Trash Updater will not touch). +- `Anime - First Release Profile` is the name of the Release Profile (taken from the `name` property + of its corresponding JSON file). diff --git a/wiki/TRaSH-Guide-Structural-Guidelines.md b/wiki/TRaSH-Guide-Structural-Guidelines.md index deebb756..34c92882 100644 --- a/wiki/TRaSH-Guide-Structural-Guidelines.md +++ b/wiki/TRaSH-Guide-Structural-Guidelines.md @@ -102,18 +102,3 @@ The following general rules apply to all lines in the markdown data: - **Sentence**: Once the term "Optional" is found in any sentence following a header, it applies to all code blocks for the remainder of that section. Once a new header is found (nested or not), terms are not considered optional anymore. - -### Release Profile Naming - -The script procedurally generates a name for release profiles it creates. For the following example: - -```txt -[Trash] Anime - First Release Profile -``` - -The name is generated as follows: - -- `Anime` comes from the guide type (could be `WEB-DL`) -- `First Release Profile` is directly from one of the headers in the anime guide -- `[Trash]` is used by the script to mean "This release profile is controlled by the script". This - is to separate it from any manual ones the user has defined, which the script will not touch.