From db106b37ad63e264f983f9b08eb626168a40c278 Mon Sep 17 00:00:00 2001 From: Jesse Bannon Date: Tue, 4 Feb 2025 23:53:37 -0800 Subject: [PATCH] [DOCS] Overhaul configuration file getting started guide --- .../guides/getting_started/first_config.rst | 29 +++++++++++++++---- 1 file changed, 24 insertions(+), 5 deletions(-) diff --git a/docs/source/guides/getting_started/first_config.rst b/docs/source/guides/getting_started/first_config.rst index 63685116..2d1a2278 100644 --- a/docs/source/guides/getting_started/first_config.rst +++ b/docs/source/guides/getting_started/first_config.rst @@ -3,12 +3,31 @@ Basic Configuration A configuration file serves two purposes: -1. Set advanced functionality that is not specifiable in a subscription file, such as working directory location. These - are set underneath ``configuration``. -2. Create custom presets, which can drastically simplify your subscription file. These are defined underneath ``presets``. - Presets are intended to be applicable and reusable across multiple subscriptions. +1. Set application-level functionality that is not specifiable in a subscription file. + .. note:: -Below is a common configuration: + ytdl-sub does not require a configuration file. However, + certain application settings may be desirable for tweak, such as setting + ``working_directory`` to make ytdl-sub perform the initial download + to an SSD drive. + +2. Create custom presets. + .. note:: + + In the prior Initial Subscription examples, we leveraged the prebuilt preset + ``Jellyfin TV Show by Date``. This preset is entirely built using the same + YAML configuration system offered to users by using a configuration file. + +The following section attempts to demystify and explain how to... + +- Set an application setting +- Know whether or not custom presets are actually needed +- How to create a custom preset +- How to use a custom preset on subscriptions + +------------- + +how this works, and show-case how .. code-block:: yaml :linenos: