Skip to content

docs: add Sonarr/Radarr setup guide and troubleshooting (#4) - #38

Open
bugrax wants to merge 2 commits into
wouterdebie:mainfrom
bugrax:docs-setup-guide
Open

docs: add Sonarr/Radarr setup guide and troubleshooting (#4)#38
bugrax wants to merge 2 commits into
wouterdebie:mainfrom
bugrax:docs-setup-guide

Conversation

@bugrax

@bugrax bugrax commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

Summary

Addresses #4 (request for a proper setup/usage guide).

Adds two README sections:

  • Connecting Sonarr/Radarr/Whisparr — a step-by-step table of the exact
    Transmission download-client fields (Host, Port, URL Base /transmission,
    Username, Password, Category), plus a prominent note about the shared download
    path.
  • Troubleshooting — the common symptoms and fixes, led by the exact one the
    Is there a proper guide to use this?  #4 reporter hit: putioarr downloads and cleans up the files, but nothing is
    imported, because the *arr and putioarr don't see the download directory at
    the same path (needs a shared mount or a Remote Path Mapping).

Docs only — no code changes.

Adds a step-by-step "Connecting Sonarr/Radarr/Whisparr" section with the
exact Transmission download-client fields, and a Troubleshooting section.
Both center on the most common failure: the *arr and putioarr not sharing
the download path (so downloads complete and are cleaned up, but nothing is
ever imported), which needs a shared mount or a Remote Path Mapping.

Addresses wouterdebie#4.
Copilot AI review requested due to automatic review settings July 18, 2026 10:57

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds end-user documentation to help users connect putioarr to Sonarr/Radarr/Whisparr (as a Transmission-compatible download client) and diagnose common “nothing imported” failure modes, aligning with the request in Issue #4 for a proper setup/usage guide.

Changes:

  • Added a “Connecting Sonarr/Radarr/Whisparr” section with the specific Transmission client fields to configure.
  • Added a “Troubleshooting” section emphasizing shared mount/Remote Path Mapping and other common misconfigurations.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@bugrax

bugrax commented Jul 18, 2026

Copy link
Copy Markdown
Contributor Author

Good catch — escaped every *arr as \*arr in the new sections so the asterisks render literally instead of turning into emphasis. The intentional italic cross-references (*Connecting Sonarr/Radarr/Whisparr*, *Category-based Download Directories*) are left as-is.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants