diff --git a/docs/source/guides/getting_started/first_config.rst b/docs/source/guides/getting_started/first_config.rst index a1bfbef8..ce314ceb 100644 --- a/docs/source/guides/getting_started/first_config.rst +++ b/docs/source/guides/getting_started/first_config.rst @@ -1,23 +1,33 @@ Basic Configuration =================== -Your first configuration will look pretty simple: +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``. + +Below is a basic configuration: .. code-block:: yaml :linenos: configuration: - working_directory: '.ytdl-sub-downloads' + working_directory: '/mnt/ssd/.ytdl-sub-downloads' presets: TV Show: preset: - "Jellyfin TV Show by Date" - - "Only Recent" + overrides: tv_show_directory: "/ytdl_sub_tv_shows" + TV Show Only Recent: + preset: + - "Only Recent" + The first two lines in this ``config.yaml`` file are the ``configuration``, and define the ``working_directory``, which is described near the bottom of :ref:`this section ` diff --git a/docs/source/guides/getting_started/first_sub.rst b/docs/source/guides/getting_started/first_sub.rst index 22e4bf7d..a3cd2005 100644 --- a/docs/source/guides/getting_started/first_sub.rst +++ b/docs/source/guides/getting_started/first_sub.rst @@ -31,7 +31,7 @@ Your first subscription file should look something like this: = Lofi: "Game Chops": "https://www.youtube.com/playlist?list=PLBsm_SagFMmdWnCnrNtLjA9kzfrRkto4i" -Lets break this down: +Let's break this down: .. code-block:: yaml :lineno-start: 1 diff --git a/docs/source/guides/getting_started/index.rst b/docs/source/guides/getting_started/index.rst index d38fe7de..aed76dab 100644 --- a/docs/source/guides/getting_started/index.rst +++ b/docs/source/guides/getting_started/index.rst @@ -39,7 +39,7 @@ Intermediate terminology: Advanced terminology: -- ``entry variables``: Variables that derive from a downloaded yt-dlp entry. +- ``entry variables``: Variables that derive from a downloaded yt-dlp entry (media). - ``static variables``: Variables that do not have a dependency to entry variables. - ``scripting``: Syntax that allows the use of entry variables, static variables, and functions in override variables.