Commit graph

4 commits

Author SHA1 Message Date
Ross Patterson
72419a3e98
[DOCS] How to test subscription downloads (#1318)
Revise the "Getting Started" page for testing subscription downloads.
2025-09-06 08:11:06 -07:00
Ross Patterson
746370ef9a
[DOCS] usage: Stale CLI options help output (#1311)
* docs(quick): Stale Sphinx ref link target name

Not sure how I missed this in my local testing, but this should have been a part a
previous PR.

Refs #1304

* docs(usage): Stale CLI options help output

From [merged PR
feedback](https://github.com/jmbannon/ytdl-sub/pull/1305#discussion_r2304503286).

Refs #1305
2025-08-29 10:08:07 -07:00
Ross Patterson
a4b910ae74
[DOCS] FAQ: How to force re-downloading an entry (#1292)
* docs(faq): How to force re-downloading an entry

https://discord.com/channels/994270357957648404/994270357957648408/1406876595364560970

* docs(faq): Missing CLI ovrrides to re-download

* docs(faq): Misunderstood re-download CLI options

https://discord.com/channels/994270357957648404/1102703969266049174/1407956781316964372

* docs(faq): Add download missing file entry

* docs(faq): Clarify reasons to re-download files
2025-08-22 07:33:30 -07:00
Ross Patterson
e1f81e5274
[DOCS] Add Architecture section and Quick Start (#1287)
* docs(config): Clarify preset ordering priority

Refs #1276

* docs(architecture): WIP Narrative how it works

Much of this is repetition of the reference docs and some of the changes here should
also be applied here. The goal is to repeat here the parts of the reference docs that
may hang up a user when reading "Getting Started" without sending them off to get lost
in the weeds of the reference docs.

Note that this references a `Quick Start` document which is just an empty placeholder
and is to be written in a subsequent change.

Fixes #1279

* docs(terms): Glossary redundant with architecture

Now that the introduction includes an architectural overview, that section introduces
new users to necessary concepts and associated terminology and makes the terminology
section redundant in that part of the docs.

* docs(quick): Add a rote quick start guide

This is what I came up with when I tried to write instructions requiring as little
understanding as possible. Doing so really did reinforce my impression that this just
shouldn't be done, that significant understanding is required for *any* use of ytdl-sub
and even offering a quick start may be irresponsible. I'm still on the fence, thoughts?

That said, I also think I got some good explanations out of this and a better
understanding of what the next bits of the Getting Started should be. This Quick Start
is currently redundant with other parts of the Getting Started pages. I suspect that
I'll end up repeating and/or reorganizing parts of this Quick Start into the next bits
of the Getting Started. To that end I might argue that this change is a WIP and that
merging should wait. But I could also argue that this is an incremental improvement and
can be merged before that other work. Your call.

* docs(start): Various rST/Sphinx markup issues
2025-08-19 00:38:39 -07:00