fix: Address multiple issues with the config template

- Simplify the comment style for YAML intended to be uncommented by the
  user. Now they just need to delete the leading hash and YAML will be
  at the appropriate indentation.
- Add additional explanation at the top about how to set up
  configuration based on the guide.
- Fix link to the configuration reference.
pull/151/head
Robert Dailey 2 years ago
parent 4d20bdebe3
commit 2a79a50d50

@ -41,6 +41,8 @@ the executable has been removed.
### Fixed
- Sonarr: Run validation on Custom Formats configuration, if specified, to check for errors.
- Added more instructions, fixed broken links, and simplified the way you uncomment optional parts
of the YAML in the starter `recyclarr.yml` template generated by the `create-config` subcommand.
[breaking3]: https://recyclarr.dev/wiki/upgrade-guide/upgrade-guide-v3.0
[yaml-config]: https://recyclarr.dev/wiki/file-structure#directory-configs

@ -4,10 +4,15 @@
# values below as needed for your instance. You will be required to update the API Key and URL for
# each instance you want to use.
#
# Many optional settings have been omitted to keep this template simple.
# Many optional settings have been omitted to keep this template simple. Note that there's no "one
# size fits all" configuration. Please refer to the guide to understand how to build the appropriate
# configuration based on your hardware setup and capabilities.
#
# For any lines that mention uncommenting YAML, you simply need to remove the leading hash (`#`).
# The YAML comments will already be at the appropriate indentation.
#
# For more details on the configuration, see the Configuration Reference on the wiki here:
# https://github.com/recyclarr/recyclarr/wiki/Configuration-Reference
# https://recyclarr.dev/wiki/reference/config-reference
# Configuration specific to Sonarr
sonarr:

Loading…
Cancel
Save