ytdl-sub/docs/source
Ross Patterson adb08ed5f9
[DOCS] start: Clarify subscriptions file tutorial (#1310)
* docs(presets): Stale copied prebuilt comment

* docs(start): How to configure subscriptions

Revise the subscriptions file Getting Started tutorial from the perspective of a new
user. The idea is that the ref docs describe a component as the code sees it, whereas
the how-to/tutorial/getting-started docs provide a narrative description of the
component from the external perspective of a typical new user.

* docs(start): Document subscription override mode

It's debatable whether this belongs here. Having moved onto my own custom presets, the
only use cases for override mode in my subscriptions file are for those series that also
have TVDB metadata. Those ytdl-sub downloads I integrate into my Sonarr library need
per-subscription overrides such as:

- Sonarr manages years 2020-2023 for one series and ytdl-sub fills in
  from there, so set a `sonarr_series_after: "20240101"` override

- each series needs a directory named per Sonarr's configuration with the TVDB ID, the subscription key,
  but also a series name prefix without the TVDB ID for each episode file, so set a
  `sonarr_series_prefix: "Foo Series (2020)"` override

So are there other use cases for override mode that are more common and less niche than
mine?

* docs(docker): Revert example bind mount volumes

Per [PR feedback](https://github.com/jmbannon/ytdl-sub/pull/1310#discussion_r2306067263).
2025-08-28 07:09:05 -07:00
..
_static [DOCS] Tooling to auto-generate custom sphinx docs (#849) 2023-12-28 22:39:59 -08:00
config_reference [DOCS] start: Clarify subscriptions file tutorial (#1310) 2025-08-28 07:09:05 -07:00
faq [DOCS] Clarify debugging, support, reporting (#1305) 2025-08-27 09:10:01 -07:00
guides [DOCS] start: Clarify subscriptions file tutorial (#1310) 2025-08-28 07:09:05 -07:00
prebuilt_presets [DOCS] Clarify the = YAML key prefix (#1297) 2025-08-24 09:17:38 -07:00
conf.py [DOCS] Various doc cleanups (#928) 2024-02-17 08:53:06 -08:00
debugging.rst [DOCS] Clarify debugging, support, reporting (#1305) 2025-08-27 09:10:01 -07:00
deprecation_notices.rst [DOCS] Consistent headings, newlines, wraps (#1293) 2025-08-20 20:20:19 -07:00
index.rst [DOCS] Clarify debugging, support, reporting (#1305) 2025-08-27 09:10:01 -07:00
introduction.rst [DOCS] Various clarifications (#1289) 2025-08-22 07:17:32 -07:00
requirements.txt [BACKEND] Remove old format for video_tags, music_tags, download_strategy (#899) 2024-01-15 00:04:32 -08:00
usage.rst [DOCS] logs: persistent logs config (#1304) 2025-08-27 09:04:36 -07:00