From 5e5b10885193312e8792f8b67787ebc17cfea85d Mon Sep 17 00:00:00 2001 From: Jesse Bannon Date: Sun, 24 Nov 2024 08:58:44 -0800 Subject: [PATCH] more --- docs/source/guides/getting_started/index.rst | 23 +++++++++----------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/docs/source/guides/getting_started/index.rst b/docs/source/guides/getting_started/index.rst index ffdcaf74..12f8a84c 100644 --- a/docs/source/guides/getting_started/index.rst +++ b/docs/source/guides/getting_started/index.rst @@ -1,13 +1,6 @@ Getting Started =============== -Now that you've completed your install of ``ytdl-sub``, it's time to get started. This is a 3-step process: - -- Create your subscription file -- Automate starting ytdl-sub -- (Optional) Create a custom configuration file if further customization is needed - - Prerequisite Knowledge ---------------------- @@ -26,17 +19,15 @@ If you plan on using the headless image of ``ytdl-sub``, you: Additional useful (but not required) knowledge: ☑ Understanding how :yt-dlp:`\ ` works -Overview --------- - Terminology -~~~~~~~~~~~ +----------- Must-know terminology: + - ``subscription``: URL(s) that you want to download with specific metadata requirements. - ``preset``: Reusable YAML configuration, that can specify anything from metadata layout, media quality, or any feature of ytdl-sub, to apply to subscriptions. A preset can inherit other presets. -- ``prebuilt preset``: Presets that are included in ``ytdl-sub``. These do most of the work defining plugins, overrides, etc in order to make downloads ready for player consumption. -- ``override``: Verb describing the act of overriding something in a parent preset. For example, the TV Show presets practically expect you to *override* the URL variable to tell ytdl-sub where to download from. +- ``prebuilt preset``: Presets that are included in ytdl-sub. These do most of the work defining plugins, overrides, etc in order to make downloads ready for player consumption. +- ``override``: Verb describing the act of overriding something in a preset. For example, the TV Show presets practically expect you to *override* the URL variable to tell ytdl-sub where to download from. - ``override variables``: User-defined variables that are intended to *override* something. - ``subscription file``: The file to specify all of your subscriptions and some override variables. @@ -54,6 +45,12 @@ Advanced terminology: Ready to Start? --------------- +Now that you've completed your install of ``ytdl-sub``, it's time to get started. This is a 3-step process: + +- Create your subscription file +- Automate starting ytdl-sub +- (Optional) Create a custom configuration file if further customization is needed + :doc:`Step 1: Initial Subscriptions `