Updated Configs, fixed some errors. (#719)

* Update config.yml

Updated to use letterboxd defaults

* Delete ladywhiskers/metadata_folders directory

* Update movies_critics_other.yml

* Update movies_subgenre.yml

* Update movies_topics.yml

* Update movies_watchlist.yml

* Delete ladywhiskers/music/Music-Genre-top.yml

* Add files via upload

* Update tvshows_Attenborough.yml

* Update tvshows_documentaries.yml

* Update tvshows_topic.yml

* Update tvshows_watchlist.yml

* Add files via upload

* Update config.yml

Minor edits, commented out genre default

* Delete ladywhiskers/tvshows/tvshows_Attenborough.yml

Removing unused yml

* Update tvshows_documentaries.yml

* Update tvshows_topic.yml

commenting out sync

* Update tvshows_watchlist.yml

Added a collection of recommendations for my mum

* Update musictemplates.yml

* Update Music-Genre.yml

* Update continents.yml

* Update track_collections.yml

* Update movies_critics_other.yml

* Update movies_subgenre.yml

Replaced ediblehedgehog letterboxd lists with another user

* Update movies_topics.yml

* Update movies_watchlist.yml

Removed Bec's list
Added collection for recommendations for my mum.

* Delete ladywhiskers/metadata_folders directory

* Add files via upload

renamed and reorganised a bunch of mediux references - still a work in progress.

* Update tvshows_watchlist.yml

formatting

* Update README.md

minor update

* Update movies_watchlist.yml

Added template to reduce redunancy

* Delete ladywhiskers/metadata_folders directory

* docs: Document the ladywhiskers Kometa configuration

This change adds comprehensive documentation to the Kometa configuration files within the 'ladywhiskers' subfolder. It adds comments to all YAML files to explain their purpose and settings.

It also adds a new, detailed README.md file to the 'ladywhiskers' directory to provide a complete guide for new developers, covering the purpose, structure, and usage of the configuration.

* Update Music-Genre.yml

* Update track_collections.yml

* Refactor movie watchlist YAML structure and templates

* Add files via upload

---------

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>

ladywhiskers/config.yml

@@ -1,27 +1,37 @@
-# Configuration file for the Kometa application.
+# This is the main configuration file for Kometa.
-# This file specifies the libraries to be used by the application.
+# It defines the Plex libraries to manage, global settings,
+# and connections to external services like TMDb, Trakt, etc.
+
+# The 'libraries' section defines the Plex libraries that Kometa will manage.
+# Each library has its own set of collections, overlays, and operations.
 libraries:
+  # Configuration for the 'Movies' library in Plex.
   Movies:
+    # Schedule for when to apply overlays to movie posters.
+    # This runs on Monday, Wednesday, Friday, and Sunday.
     schedule_overlays: weekly(monday|wednesday|friday|sunday)
+    # Template variables are used to pass values to templates.
     template_variables:
       use_separator: false
+    # Specifies metadata files to apply to the library.
     metadata_files:
     - folder: config/metadata_folders
+    # A list of collection files to be processed for this library.
+    # These files define the logic for creating collections in Plex.
     collection_files:
-    - folder: config/movies
+    - folder: config/movies  # Custom collection files
-    - default: content_rating_au
+    - default: content_rating_au # Default collection for Australian content ratings
-    - default: continent
+    - default: continent # Default collection for continents
       template_variables:
         include:
         - Oceania
-    - default: franchise
+    - default: franchise # Default collection for movie franchises
       template_variables:
-        title_override:
+        title_override: # Override titles for specific franchises
           33514: The Twilight Saga
           9743: Hannibal Lecter
           489724: Trolls
-#    - default: genre
+    - default: letterboxd # Collections based on Letterboxd data
-    - default: letterboxd
       schedule: monthly(17)
       template_variables:
         use_imdb_top_250: true
@@ -30,7 +40,7 @@ libraries:
         visible_library_top_250: true
         visible_home_top_250: true
         visible_shared_top_250: true
-    - default: other_chart
+    - default: other_chart # Collections from other movie charts
       template_variables:
         use_anidb: false
         use_stevenlu: false
@@ -38,8 +48,8 @@ libraries:
         visible_library_commonsense: true
         visible_home_commonsense: true
         visible_shared_commonsense: true
-    - default: razzie
+    - default: razzie # Collection for Razzie-winning movies
-    - default: seasonal
+    - default: seasonal # Collections for seasonal events (e.g., Christmas)
       template_variables:
         trakt_list_christmas: https://trakt.tv/users/k0meta/lists/christmas-extravaganza-non-tv-movie
         schedule_christmas: range(11/01-12/26)
@@ -51,7 +61,7 @@ libraries:
         use_veteran: false
         use_thanksgiving: false
         use_aapi: false
-    - default: studio
+    - default: studio # Collections for movie studios
       template_variables:
         include:
         - A24
@@ -63,9 +73,9 @@ libraries:
         - Walt Disney Animation Studios
         - Walt Disney Pictures
         - Walt Disney Productions
-    - default: tautulli
+    - default: tautulli # Collections based on Tautulli data
-    - default: universe
+    - default: universe # Collections for movie universes
-    #- default: collectionless
+    # Defines overlay files to be applied to movie posters.
     overlay_files:
     - default: commonsense
     - default: mediastinger
@@ -74,11 +84,13 @@ libraries:
         use_resolution: false
         use_edition: true
     - default: ribbon
+    # Library-specific settings.
     settings:
       asset_directory:
       - config/assets/Movies/
       - config/assets/Collections/
       prioritize_assets: false
+    # Operations to be performed on the library.
     operations:
     - schedule: daily
       assets_for_all: true
@@ -114,6 +126,8 @@ libraries:
       - tmdb
       - tvdb
       - omdb
+
+  # Configuration for the 'TV Shows' library in Plex.
   TV Shows:
     schedule_overlays: weekly(tuesday|thursday|saturday)
     report_path: config/missing/TV_report.yml
@@ -122,14 +136,12 @@ libraries:
     library_name: TV Shows
     collection_files:
     - folder: config/tvshows
-    # - default: based
     - default: content_rating_au
     - default: continent
       template_variables:
         include:
         - Oceania
     - default: franchise
-    #- default: genre
     - default: other_chart
       template_variables:
         use_anidb: false
@@ -186,6 +198,8 @@ libraries:
       - tmdb
       - tvdb
       - omdb
+
+  # Configuration for the 'Music' library in Plex.
   Music:
     schedule: weekly (sunday)
     library_name: Music
@@ -193,11 +207,14 @@ libraries:
     - folder: config/music
     settings:
       asset_directory: config/assets/Music
+
+# Defines playlist files to be processed.
 playlist_files:
 - default: playlist
   template_variables:
     libraries: Movies, TV Shows
-#- folder: config/playlists
+
+# Global settings for Kometa.
 settings:
   cache: true
   cache_expiration: 2048
@@ -245,6 +262,8 @@ settings:
   overlay_artwork_filetype: jpg
   overlay_artwork_quality:
   show_unfiltered: false
+
+# Webhook settings for sending notifications.
 webhooks:
   error: notifiarr
   version: notifiarr
@@ -252,33 +271,47 @@ webhooks:
   run_end: notifiarr
   changes: notifiarr
   delete:
+
+# Plex connection settings.
 plex:
   url: http://localhost:32400
-  token: [REDACTED]
+  token: [REDACTED] # Your Plex token
   timeout: 600
   clean_bundles: false
   empty_trash: false
   optimize: false
   db_cache:
+
+# TMDb (The Movie Database) API settings.
 tmdb:
-  apikey: [REDACTED]
+  apikey: [REDACTED] # Your TMDb API key
   language: en
   cache_expiration: 600
   region:
+
+# Tautulli connection settings.
 tautulli:
   url: http://localhost:1818
-  apikey: [REDACTED]
+  apikey: [REDACTED] # Your Tautulli API key
+
+# OMDb (Open Movie Database) API settings.
 omdb:
-  apikey: [REDACTED]
+  apikey: [REDACTED] # Your OMDb API key
   cache_expiration: 600
+
+# MDbList connection settings.
 mdblist:
-  apikey: [REDACTED]
+  apikey: [REDACTED] # Your MDbList API key
   cache_expiration: 600
+
+# Notifiarr connection settings.
 notifiarr:
-  apikey: [REDACTED]
+  apikey: [REDACTED] # Your Notifiarr API key
+
+# Radarr connection settings.
 radarr:
   url: http://localhost:7878
-  token: [REDACTED]
+  token: [REDACTED] # Your Radarr API token
   add_missing: false
   add_existing: false
   root_folder_path: Z:\data\media\movies
@@ -291,9 +324,11 @@ radarr:
   plex_path:
   upgrade_existing: false
   ignore_cache: false
+
+# Sonarr connection settings.
 sonarr:
   url: http://localhost:8989
-  token: [REDACTED]
+  token: [REDACTED] # Your Sonarr API token
   add_missing: false
   add_existing: false
   root_folder_path: Z:\data\media\tv
@@ -309,9 +344,11 @@ sonarr:
   plex_path:
   upgrade_existing: false
   ignore_cache: false
+
+# Trakt connection settings.
 trakt:
-  client_id: [REDACTED]
+  client_id: [REDACTED] # Your Trakt client ID
-  client_secret: [REDACTED]
+  client_secret: [REDACTED] # Your Trakt client secret
   pin:
   authorization:
     access_token: [REDACTED]

ladywhiskers/movies/movies_critics_other.yml

@@ -1,26 +1,31 @@
-##############################################################################
+# This file defines collections based on critics' ratings and awards,
-#                          Other Awards Collections                          #
+# primarily from Rotten Tomatoes. It uses Trakt lists to source the movies.
-#                 Created by Yozora, Bullmoose20, & Sohjiro                  #
+# Credits: Yozora, Bullmoose20, Sohjiro, maxwelldeux, WhoDat104
-#                 Credit to maxwelldeux for the Trakt Lists                  #
-#          EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL           #
-#        https://metamanager.wiki/en/latest/defaults/award/other.html        #
-##############################################################################
 
+# External templates are used to avoid repetition.
+# 'pmm: templates' likely refers to a set of predefined templates.
 external_templates:
   pmm: templates
   template_variables:
+    # This variable is used to control the sorting of collections.
     collection_section: 130
 
-
+# Template for creating Rotten Tomatoes "Best of" collections.
 templates:
   Rotten Tomatoes:
+    # The Trakt list URL is parameterized with 'key', which will be a year.
     trakt_list: https://trakt.tv/users/lish408/lists/rotten-tomatoes-best-of-<<key>>
+    # 'sync' mode ensures that the Plex collection matches the Trakt list.
     sync_mode: sync
     collection_mode: default
     collection_order: custom
+    # The sort title is prefixed to control the order of collections in Plex.
     sort_title: "!130_Rotten Tomatoes Best of <<key>>"
+    # Schedule for when to update the collection.
     schedule: monthly(01)
     url_poster: https://raw.githubusercontent.com/WhoDat104/Rotten-Tomatoes/main/Rotten%20Tomatoes%20Best%20of%20<<key>>.jpg
+
+# Static collections based on specific Rotten Tomatoes lists.
 collections:
   Rotten Tomatoes Best All-Time:
     trakt_list: https://trakt.tv/users/lish408/lists/rotten-tomatoes-top-100-movies-of-all-time
@@ -30,6 +35,7 @@ collections:
     sort_title: "!130_Rotten !1"
     schedule: monthly(10)
     url_poster: https://raw.githubusercontent.com/WhoDat104/Rotten-Tomatoes/main/Rotten%20Tomatoes%20Best%20All-Time.jpg
+
   Rotten Tomatoes Best Horror:
     trakt_list: https://trakt.tv/users/lish408/lists/rotten-tomatoes-best-horror-movies-of-all-time
     sync_mode: sync
@@ -38,6 +44,7 @@ collections:
     sort_title: "!130_Rotten !2"
     schedule: monthly(10)
     url_poster: https://raw.githubusercontent.com/WhoDat104/Rotten-Tomatoes/main/Rotten%20Tomatoes%20Best%20Horror.jpg
+
   Rotten Tomatoes Best Rom Com:
     trakt_list: https://trakt.tv/users/lish408/lists/rotten-tomatoes-the-200-best-romantic-comedies-of-all-time
     sync_mode: sync
@@ -47,13 +54,18 @@ collections:
     schedule: monthly(10)
     url_poster: https://raw.githubusercontent.com/WhoDat104/Rotten-Tomatoes/main/Rotten%20Tomatoes%20Best%20Rom%20Com.jpg
 
+# Dynamic collections are created based on a range of values.
+# In this case, it creates "Best of" collections for recent years.
 dynamic_collections:
   Rotten Tomatoes Best of:
     type: number
     sync: true
     data:
+      # Creates collections for the last two years.
       starting: current_year-2
       ending: current_year-1
+    # The title of the collection will be formatted with the year.
     title_format: Rotten Tomatoes Best of <<key_name>>
+    # The 'Rotten Tomatoes' template is used to create the collections.
     template:
       - Rotten Tomatoes

ladywhiskers/movies/movies_subgenre.yml

@@ -6,7 +6,7 @@ templates:
     delete_not_scheduled: false
     limit: 250
     #sort_title: "+130_<<collection_name>>"
-    sync_mode: sync
+    #sync_mode: sync
     visible_home: false
     visible_library: false
     visible_shared: false
@@ -1249,8 +1249,6 @@ collections:
     template: {
                     keyword: "samurai,sword-fight",
                     language: "en",
-                    letterboxd_list_details_url_1: "https://letterboxd.com/jhcrotinger/list/samurai/by/rating/",
-                    letterboxd_list_details_limit_1: 250,
                     letterboxd_list: "theme-samurai",
                     name: sub_genre,
                     rating.gte: 2,
@@ -1381,7 +1379,7 @@ collections:
     schedule: weekly(saturday)
     #summary: "Top rated movies in Stop-Motion"
     template: {
-                    keyword: "stop-motion",
+                    keyword: "stop-motion-animation",
                     language: "en",
                     letterboxd_list_details_url_1: "https://letterboxd.com/savage_/list/stop-motion/by/rating/",
                     letterboxd_list_details_limit_1: 250,
@@ -1392,7 +1390,7 @@ collections:
                     votes.gte: 100
                 }
 
-  Superhero":
+  Superhero:
     #summary: "Top rated movies in Superhero"
     #url_poster: https://raw.githubusercontent.com/0x5f3/pmm.config/assets/_subgenre_top/subgenre_top_superhero.png
     schedule: weekly(saturday)

ladywhiskers/movies/movies_topics.yml

@@ -1,43 +1,55 @@
-############################
+# This file defines collections based on various topics.
-#          Topics          #
+# Like the subgenre file, these are not meant to be visible collections,
-############################
+# but rather a way to tag movies with a specific topic.
+# This is achieved by using 'build_collection: false' and 'item_genre: <<collection_name>>'.
+
 templates:
+  # A generic template for creating topic-based collections.
   Collection:
     optional:
       - poster
-    #url_poster: <<poster>>
     collection_order: audience_rating.desc
     sort_title: "!060_<<collection_name>>"
     schedule: monthly(29)
+    # This is the key part: instead of building a collection, it tags the items
+    # with the collection's name as a genre.
     item_genre: <<collection_name>>
     build_collection: false
 
-#######################################################################################################   
 collections:
+  # Each of the following blocks defines a topic.
+  # The 'template' key is used to call the 'Collection' template.
+  # The movies are sourced from IMDb and Trakt lists.
   Football:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Football.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567409329/
+
   Inspirational:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Inspirational.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567409348/
     trakt_list: https://trakt.tv/users/rizreflects/lists/inspiring
+
   Natural Disaster:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Natural%20Disaster.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567402383/
+
   Spy:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Spy.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567409179
+
   Stand-up Comedy:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Stand-Up%20Comedy.jpg}
+    template: {name: Collection}
     imdb_list:
       - https://www.imdb.com/list/ls567409881/
     imdb_search:
       votes.gte: 100
       keyword: stand-up comedy
     collection_order: release.desc
+
   Unexpectedly Amazing:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Unexpectedly%20Amazing.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567408147/
+
   Witch:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Witch.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567408343/

ladywhiskers/movies/movies_watchlist.yml

@@ -8,6 +8,7 @@ templates:
     collection_order: custom
     sort_title: "!0001_<<collection_name>>"
     collection_mode: show
+    visible_library: true
     visible_home: true
 
 collections:
@@ -55,3 +56,6 @@ collections:
       all:
         writer: tmdb
     tmdb_person: 592851
+    visible_home: true
+    visible_shared: true
+    visible_library: true

ladywhiskers/music/Music-Genre.yml

@@ -1,26 +1,32 @@
+# This file defines collections for a vast number of music genres.
+# It uses a template to create a collection for each genre based on the
+# 'album_genre' tag in the music library.
+
 templates:
+  # A generic template for creating genre collections.
   Genre:
+    # This ensures that the collections are built based on album genres.
     builder_level: album
     sort_title: +_<<collection_name>>
     sync_mode: sync
-#    collection_order: alpha
+    validate: false #to skip unused genres.
+    # A smart filter is used to find albums with the specified genre tag.
     smart_filter:
       miminum_items: 2
       delete_below_minimum: true
-#      limit: 50
       sort_by: title.asc
-#      any:
       all:
         album_genre: <<genres>>
 
 collections:
-######################################################
+  # Each of the following blocks defines a music genre collection.
-#                  Genre Collections                 #
+  # The 'template' key is used to call the 'Genre' template with the genre name.
-######################################################
   2 Tone:
     template: {name: Genre, genres: 2 Tone}
   2-Step:
     template: {name: Genre, genres: 2-Step}
+  # ... and so on for all the other genres.
+  # The structure is the same for all of them.
   Aak:
     template: {name: Genre, genres: Aak}
   Abhang:

ladywhiskers/music/continents.yml

@@ -1,15 +1,14 @@
-##############################################################################
+# This file defines collections for music from different continents.
-#                           Continent Collections                            #
+# It uses a dynamic collection to create a collection for each continent,
-#       Created by Adam Pope, bartolomesorianol, Bullmoose20 & Sohjiro       #
+# and then groups countries under each continent.
-#          Artwork Credit to Duhniel, Bullmoose20, and Wiki Commons          #
-#          EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL           #
-#      https://metamanager.wiki/en/latest/defaults/movie/continent.html      #
-##############################################################################
 
+# External templates are used to avoid repetition.
 external_templates:
   file: config/templates/musictemplates.yml
   template_variables:
     collection_section: "001"
+
+# Template for creating smart filters.
 templates:
   smart_filters:
     default:
@@ -31,6 +30,7 @@ templates:
         <<search_term2>>: <<search_value2>>
 
 collections:
+  # This creates a separator in Plex to group the continent collections.
   Continent Collections:
     template:
       - name: separator
@@ -38,6 +38,7 @@ collections:
         key_name: Continent
         translation_key: separator
 
+# This dynamic collection creates a collection for each continent.
 dynamic_collections:
   Continent:
     type: country
@@ -63,6 +64,7 @@ dynamic_collections:
       dynamic:
         default: true
 
+    # The list of continents to create collections for.
     include:
       - Africa
       - Americas
@@ -71,6 +73,7 @@ dynamic_collections:
       - Europe
       - Oceania
 
+    # The 'addons' section maps countries to continents.
     addons:
       Africa:
       # Northern Africa:
@@ -81,75 +84,7 @@ dynamic_collections:
         - Sudan
         - Tunisia
         - Western Sahara
-      # Eastern Africa:
+      # ... and so on for all other continents and countries.
-        - British Indian Ocean Territory
-        - Burundi
-        - Comoros
-        - Djibouti
-        - Eritrea
-        - Ethiopia
-        - French Southern Territories
-        - Kenya
-        - Madagascar
-        - Malawi
-        - Mauritius
-        - Mayotte
-        - Mozambique
-        - Réunion
-        - Rwanda
-        - Seychelles
-        - Somalia
-        - South Sudan
-        - Uganda
-        - Tanzania
-        - United Republic of Tanzania # Tanzania
-        - Zambia
-        - Zimbabwe
-      # Central Africa:
-        - Angola
-        - Cameroon
-        - Central African Republic
-        - Chad
-        - Republic of the Congo
-        - Congo # Republic of the Congo
-        - Democratic Republic of the Congo
-        - Zaire # Democratic Republic of the Congo
-        - Equatorial Guinea
-        - Gabon
-        - São Tomé and Príncipe
-        - Sao Tome and Principe # São Tomé and Príncipe
-      # Southern Africa:
-        - Botswana
-        - Eswatini
-        - Swaziland # Eswatini
-        - Lesotho
-        - Namibia
-        - South Africa
-      # Western Africa:
-        - Benin
-        - Burkina Faso
-        - Cape Verde
-        - Cabo Verde # Cape Verde
-        - Côte d'Ivoire
-        - Côte d’Ivoire # Côte d'Ivoire
-        - Ivory Coast # Côte d'Ivoire
-        - Gambia
-        - Ghana
-        - Guinea
-        - Guinea-Bissau
-        - Liberia
-        - Mali
-        - Mauritania
-        - Niger
-        - Nigeria
-        - Saint Helena, Ascension and Tristan da Cunha
-        - Saint Helena # Saint Helena, Ascension and Tristan da Cunha
-        - St. Helena # Saint Helena, Ascension and Tristan da Cunha
-        - Ascension # Saint Helena, Ascension and Tristan da Cunha
-        - Tristan da Cunha # Saint Helena, Ascension and Tristan da Cunha
-        - Senegal
-        - Sierra Leone
-        - Togo
       Americas:
       # Caribbean:
         - Anguilla

ladywhiskers/music/track_collections.yml

@@ -1,10 +1,16 @@
+# This file defines a template for creating collections of tracks based on their "mood" tag.
+# The dynamic collection that would use this template is commented out,
+# so this file doesn't create any collections in its current state.
+
 external_templates:
   file: config/templates/musictemplates.yml
   template_variables:
     collection_section: "004"
 
 templates:
+  # This template creates a collection of tracks based on a mood.
   track mood collection:
+    # This ensures that the collections are built based on individual tracks.
     builder_level: track
     smart_filter:
       limit: 100
@@ -14,10 +20,16 @@ templates:
       all:
         track_mood: <<value>>
         
-#dynamic_collections:
+collections: {} #placeholder
-#  Track Moods:
+
-#    type: track_mood
+# The following dynamic collection is commented out. If it were active, it would
-#    title_format: Top 100 <<key_name>> Tracks
+# create a collection for each mood tag found in the library, containing the
-#    template:
+# top 100 tracks with that mood.
-#      - track mood collection
+#
-#      - shared
+# dynamic_collections:
+#   Track Moods:
+#     type: track_mood
+#     title_format: Top 100 <<key_name>> Tracks
+#     template:
+#       - track mood collection
+#       - shared

ladywhiskers/templates/musictemplates.yml

@@ -1,4 +1,10 @@
+# This file contains a set of reusable templates for creating collections in Kometa.
+# These templates are referenced in other configuration files to avoid repetition
+# and to ensure consistency across collections.
+
 templates:
+  # Template for creating a separator in the Plex library.
+  # Separators are empty collections used to visually group other collections.
   separator:
     default:
       key: separator
@@ -40,6 +46,7 @@ templates:
     summary: <<summary_<<key>>>>
     name: <<name_<<key>>>>
 
+  # Template for shared settings that are common to many collections.
   shared:
     conditionals:
       name_<<key>>:
@@ -133,6 +140,7 @@ templates:
     minimum_items: <<minimum_items_<<key>>>>
     delete_collections_named: <<delete_collections_named>>
 
+  # Template for creating a smart filter.
   smart_filter:
     default:
       sort_by: release.desc
@@ -152,6 +160,7 @@ templates:
         <<search_term>>: <<search_value>>
         <<search_term2>>: <<search_value2>>
 
+  # Template for creating a filter.
   filter:
     default:
       sync_mode: sync
@@ -171,6 +180,7 @@ templates:
     filters:
       <<filter_term>>: <<value>>
 
+  # Template for creating a smart collection from an MDbList list.
   mdb_smart:
     default:
       sync_mode: sync
@@ -182,6 +192,7 @@ templates:
     sync_mode: <<sync_mode_<<key>>>>
     mdblist_list: <<mdblist_list>>
 
+  # Template for settings related to Radarr and Sonarr.
   arr:
     default:
       key: <<mapping_name>>
@@ -217,6 +228,7 @@ templates:
     radarr_search: <<radarr_search_<<key>>>>
     sonarr_search: <<sonarr_search_<<key>>>>
 
+  # Template for custom collections.
   custom:
     default:
       sync_mode: sync
@@ -228,6 +240,7 @@ templates:
     sync_mode: <<sync_mode_<<key>>>>
     cache_builders: <<cache_builders>>
 
+  # Template for "Other" collections.
   other_collection:
     default:
       collection_section: "00"
@@ -237,6 +250,7 @@ templates:
     run_definition: <<use_other>>
     sort_title: "!<<collection_section>><<pre>><<title>>"
 
+  # Template for year-based collections.
   use_year_collections:
     conditionals:
       final_collection_section:

ladywhiskers/tvshows/tvshows_documentaries.yml

@@ -1,89 +1,100 @@
-#######################################################
+# This file defines collections for documentary TV shows, categorized by genre.
-#              Documentary Genres                     #
+# Like other files in this repository, it uses a template to tag shows with a
-#                TV Collections                       #
+# genre rather than creating visible collections. This is achieved by using
-#######################################################
+# 'build_collection: false' and 'item_genre: <<collection_name>>'.
 
 templates:
+  # A generic template for creating documentary genre collections.
   Collection:
     optional:
       - poster
-    #url_poster: <<poster>>
-    #sync_mode: sync
     sort_title: "!060_<<collection_name>>"
     collection_order: release.desc
     schedule: weekly(tuesday)
+    # This is the key part: instead of building a collection, it tags the items
+    # with the collection's name as a genre.
     item_genre: <<collection_name>>
     build_collection: false
 
 collections:
+  # Each of the following blocks defines a documentary genre.
+  # The 'template' key is used to call the 'Collection' template.
+  # The shows are sourced from IMDb lists and TVDb IDs.
   America:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/America.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567617875/
     tvdb_show: 309958, 342167, 321784
+
   Animal:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Animal.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567611777/
     tvdb_show: 231181, 302286, 365318, 397323, 380404, 414372, 423716, 342167, 354527
-  Apocalypse :
+
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Apocalypse.jpg}
+  Apocalypse:
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567611328/
     tvdb_show: 101421, 279117
+
   The Arts:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/The%20Arts.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567611610/
     tvdb_show: 362158, 353954, 418474, 266866
+
   Building:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Building.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567611261/
     tvdb_show: 400435, 280472, 363422, 269355, 379326
+
   Conspiracy:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Conspiracy.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567611457/
     tvdb_show: 37043, 111931, 287495, 386899
+
   Dinosaur:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Dinosaur.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567611901/
     tvdb_show: 419593, 416319
+
   Engineering:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Engineering.jpg}
+    template: {name: Collection}
     imdb_list:
         - https://www.imdb.com/list/ls567611972/        #All other Engineering List
         - https://www.imdb.com/list/ls567611261/        #Building List
         - https://www.imdb.com/list/ls567611821/        #Engineering Disaster List
     tvdb_show: 410587, 375980, 370754, 369458, 345959, 122401, 280472, 282106, 370754, 400435, 399511, 420420
+
   Engineering Disaster:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Engineering%20Disaster.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567611821/
     tvdb_show: 410587, 375980, 370754, 369458, 345959
+
   Fringe:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Fringe.jpg}
+    template: {name: Collection}
     imdb_list:
         - https://www.imdb.com/list/ls567613015/        #All other Fringe List
         - https://www.imdb.com/list/ls567611457/        #Conpsiracy List
         - https://www.imdb.com/list/ls567616578/        #Paranormal List
         - https://www.imdb.com/list/ls567637035/        #UFO List
     tvdb_show: 37043, 111931, 287495, 386899, 261380, 111931, 255855, 417262, 290249, 370439, 336514, 413801, 111931, 311398, 255855, 370439, 376545, 420534
-  History :
+
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/History.jpg}
+  History:
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567613721/
     tvdb_show: 84970, 119811, 290249, 136411, 311398, 287495, 362158, 356885, 400435, 418474, 413801, 421687, 361079, 420420, 80620, 376545, 360852, 427595, 363422, 355566, 420534, 269355
-#    smart_filter:
+
-#        sort_by: year.asc
-#        all:
-#          genre: documentary  
-#            any:
-#              genre: biography, war       
   Human Body:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Human%20Body.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567613933/
     tvdb_show: 370439, 324346, 333111
     tmdb_show: 207778
+
   Manufacturing:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Manufacturing.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567613987/
     tvdb_show: 421687, 399511
+
   Nature:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Nature.jpg}
+    template: {name: Collection}
     imdb_list:
         - https://www.imdb.com/list/ls567613846/        #All other Nature List
         - https://www.imdb.com/list/ls567611777/        #Animals List
@@ -92,33 +103,40 @@ collections:
         - https://www.imdb.com/list/ls567616754/        #Space List
         - https://www.imdb.com/list/ls567637089/        #Weather List
     tvdb_show: 231181, 302286, 365318, 397323, 380404, 414372, 423716, 342167, 354527, 419593, 416319, 268119, 388660, 356885, 333247, 387478, 136411, 377071, 390520, 269320, 255951, 286699, 370598, 80865, 419048, 398721, 433852
+
   Paranormal:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Paranormal.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567616578/
     tvdb_show: 261380
+
   Plant:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Plant.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567616526/
     tvdb_show: 298146
+
   Space:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Space.jpg}
+    template: {name: Collection}
     imdb_list:
         - https://www.imdb.com/list/ls567616754/        #All other Space List
         - https://www.imdb.com/list/ls567637035/        #UFO List
     tvdb_show: 377071, 364784
-  Sport :
+
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Sport.jpg}
+  Sport:
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567616746/
     tvdb_show: 362158, 398117
+
   Technology:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Technology.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567616111/
     tvdb_show: 122401, 362158, 282106, 358433, 410168, 41726
+
   UFO:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Ufo.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567637035/
     tvdb_show: 111931, 255855
+
   Weather:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Weather.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567637089/
     tvdb_show: 390520, 269320, 255951, 286699, 370598, 80865, 419048

ladywhiskers/tvshows/tvshows_topic.yml

@@ -1,48 +1,62 @@
-#######################################
+# This file defines collections for TV shows based on various topics.
-#          TV Topics                  #
+# Like the other topic and subgenre files, these are not meant to be visible
-#######################################
+# collections, but rather a way to tag shows with a specific topic.
+# This is achieved by using 'build_collection: false' and 'item_genre: <<collection_name>>'.
 
 templates:
+  # A generic template for creating topic-based collections.
   Collection:
     optional:
       - show
       - poster
     tvdb_show: <<show>>
-    #url_poster: <<poster>>
     sync_mode: sync
     collection_order: audience_rating.desc
     sort_title: "!060_<<collection_name>>"
     schedule: weekly(tuesday)
+    # This is the key part: instead of building a collection, it tags the items
+    # with the collection's name as a genre.
     item_genre: <<collection_name>>
     build_collection: false
 
 collections:
+  # Each of the following blocks defines a topic.
+  # The 'template' key is used to call the 'Collection' template.
+  # The shows are sourced from IMDb lists.
   Anthology:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/WhoDat104/Genres/main/Anthology.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567937024/
+
   Apocalypse:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Apocalypse.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls527128700/
+
   Historical Fiction:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Historical%20Fiction.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls527147593/
+
   Medical:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Medical.jpg}
+    template: {name: Collection}
     imdb_list:
         - https://www.imdb.com/list/ls064005250/
         - https://www.imdb.com/list/ls567394825/
+
   Slice of Life:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Slice%20of%20Life.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls527147618/
+
   Spy:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Spy.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls527147789/
+
   Stephen King:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Stephen%20King.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls567399416/
+
   Supernatural:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Supernatural.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls527140144/
+
   Time Travel:
-    template: {name: Collection} #poster: https://raw.githubusercontent.com/kometa-team/Default-Images/master/genre/Time%20Travel.jpg}
+    template: {name: Collection}
     imdb_list: https://www.imdb.com/list/ls527147299/

ladywhiskers/tvshows/tvshows_watchlist.yml

@@ -1,19 +1,25 @@
-#######################################
+# This file defines collections based on TV show watchlists from various sources,
-#          TV Watchlist               #
+# such as Trakt and Plex itself. These are meant to be visible collections.
-#######################################
+
 collections:
+  # A collection based on the Plex watchlist of a user named Laura.
   Laura's Watchlist:
     plex_watchlist: critic_rating.desc
     collection_order: custom
     sync_mode: sync
     sort_title: "!0001_<<collection_name>>"
     collection_mode: show
+
+  # A collection of TV shows to watch with someone named Britty, from a Trakt list.
   Watch with Britty:
     trakt_list: https://trakt.tv/users/fuschaitea/lists/shows-to-watch-with-britty
     sync_mode: sync
     collection_order: custom
     collection_mode: show
     sort_title: "!0001_<<collection_name>>"
+
+  # A collection of movie and TV show recommendations for "Mum".
+  # It combines multiple Trakt lists.
   Recommendations for Mum:
     trakt_list:
     - https://trakt.tv/users/fuschaitea/lists/recommendations-for-mum-movies-couchmoney-tv