Where to Find Troubleshooting and FAQ Help for ytdl-sub

Updated

The ytdl-sub User Guide has dedicated FAQ and Debugging sections in its navigation, alongside Deprecation Notices and a full Reference area. When ytdl-sub misbehaves, start with Debugging for diagnostic guidance, check FAQ for known behaviors, confirm your configuration against the Configuration File, Presets, and Subscription File reference pages, and read Deprecation Notices if something that used to work has changed. The Development and Contributing section is the place to look for how to report an issue.

The help sections in the guide

The guide's navigation lists these sections relevant to troubleshooting:

Section What it is for
FAQ Common questions and expected behavior
Debugging Guidance for investigating unexpected results
Deprecation Notices Behavior that has changed or been removed
Configuration File Reference for config fields and structure
Presets / Prebuilt Preset Reference Reference for preset definitions and options
Subscription File Reference for how subscriptions are defined
Plugins / Scripting Reference for extending behavior
Development and Contributing How to contribute and report problems

The guide is authored by Jesse Bannon and carries a copyright notice through 2026.

A practical order to work through

  1. Reproduce and note the symptom. Write down the command you ran, the subscription or config file involved, and the exact output or missing result.
  2. Read Debugging. It is the section intended for diagnosing why output differs from expectations.
  3. Check FAQ. If the behavior is common, the answer is likely already stated there.
  4. Verify your configuration against the reference pages. Compare your config file, presets, and subscription file with the documented fields and preset definitions. A large share of "it does nothing" cases come down to a preset or field that does not mean what the user assumed.
  5. Check Deprecation Notices. If a setup worked previously and now does not, a changed or removed option is a likely cause.
  6. Report through Development and Contributing. If the guide does not cover your case, that section describes how to engage with the project.

What to include when asking for help

Since the guide does not document a formal issue template, prepare the details a maintainer would need:

  • The ytdl-sub version you are running
  • Your configuration file and the relevant subscription file, with credentials removed
  • The preset(s) in use
  • The command executed and its full output
  • What you expected versus what happened

Common sticking points

  • Assuming a preset does what its name suggests. Presets are documented in the Prebuilt Preset Reference; verify the actual behavior there rather than inferring from the name.
  • Editing config without checking the reference. Field names and nesting are defined in the Configuration File section; small mismatches can silently change behavior.
  • Missing a deprecation. Older examples circulating online may use options that have since changed; the Deprecation Notices page is the authority.
  • Skipping Debugging because the FAQ has no entry. The Debugging section exists precisely for cases the FAQ does not cover.

The guide does not state pricing or access restrictions for the documentation itself; treat the site as the primary source and check it directly for the current version of each section.