From ca17441c57bfb8321d6480f6452b0d44db437f6b Mon Sep 17 00:00:00 2001 From: Ross Patterson Date: Wed, 20 Aug 2025 01:56:56 -0700 Subject: [PATCH] docs(various): Minor typo and formatting fixes --- docs/source/guides/getting_started/index.rst | 6 +++--- docs/source/guides/install/docker.rst | 4 ++-- docs/source/introduction.rst | 4 ++++ 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/source/guides/getting_started/index.rst b/docs/source/guides/getting_started/index.rst index 6e38c249..f7674108 100644 --- a/docs/source/guides/getting_started/index.rst +++ b/docs/source/guides/getting_started/index.rst @@ -65,8 +65,8 @@ Plugins do the work ``ytdl-sub`` applies the plugins that the presets configure when it downloads a subscription. :doc:`The plugins <../../config_reference/plugins>` control how to run ``yt-dlp``, which media in the subscription to download, how to collect and format -metadata for those media, and how to place the resulting files into your media library, -and more. +metadata for those media, how to place the resulting files into your media library, and +more. Presets and subscriptions accept overrides ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -101,7 +101,7 @@ The configuration file extends pre-defined presets ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Users define additional presets in :doc:`their configuration file <./first_config>` that -they then use in most of their subscriptions. Most user-defines presets extend the +they then use in most of their subscriptions. Most user-defined presets extend the :doc:`../../prebuilt_presets/index` provided by ``ytdl-sub``. Caveats diff --git a/docs/source/guides/install/docker.rst b/docs/source/guides/install/docker.rst index 5c68db83..4a4481cd 100644 --- a/docs/source/guides/install/docker.rst +++ b/docs/source/guides/install/docker.rst @@ -119,5 +119,5 @@ Configuration In these examples, the configuration files will be at ``/config.yaml`` and -``/subscriptions.yaml``. Starting the container the first time -will populate those files with default examples. +``/subscriptions.yaml``. Start the container the first time to +populate those files with default examples. diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst index a72abec3..1660a87c 100644 --- a/docs/source/introduction.rst +++ b/docs/source/introduction.rst @@ -17,9 +17,13 @@ and how it should appear in your media library servers and applications such as To these ends, ``ytdl-sub``: - wraps and runs `yt-dlp`_, per your configuration to: + - download the media, remux and/or optionally transcode it + - prepares additional metadata both embedded and in external files + - renames the resulting files + - places them in your library .. figure:: https://user-images.githubusercontent.com/10107080/182677243-b4184e51-9780-4094-bd40-ea4ff58555d0.PNG