Skip to content

Document download-client drift for the next release - #172

Merged
enoch85 merged 11 commits into
mainfrom
copilot/update-docs-for-maintainerr-release
Sep 11, 2026
Merged

enoch85 merged 11 commits into
mainfrom
copilot/update-docs-for-maintainerr-release

Conversation

Copilot AI commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

The Next docs were behind the current download-client surface in Maintainerr: they still described qBittorrent-only cleanup and omitted the new download_client_type contract. This updates the unreleased docs to match the current configuration, migration, and settings API behavior.

  • Configuration

    • Document qBittorrent and Transmission as supported download clients
    • Add the client selector, Transmission RPC URL shape, and shared cleanup behavior
    • Clarify fallback seeding behavior when the selected client does not enforce its own seeding goal
    • Keep the shared-data safeguard described in client-agnostic terms
  • Migration

    • Note the new download_client_type setting
    • Call out that upgrades default existing installs to qbittorrent
  • Settings API

    • Add download_client_type to the download-client request/response contract
    • Document the reset behavior on DELETE /api/settings/download-client
    • Update connection-test semantics and error wording for the selected client
    • Document Transmission’s RPC endpoint shape alongside the existing qBittorrent WebUI URL

Example request body now documented for the settings API:

{
  "download_client_type": "qbittorrent",
  "download_client_url": "http://qbittorrent:8080",
  "download_client_username": "user",
  "download_client_password": "...",
  "download_client_delete_data": true,
  "download_client_fallback_ratio": 0.5
}

Copilot AI and others added 8 commits September 11, 2026 20:52
Co-authored-by: enoch85 <4511254+enoch85@users.noreply.github.com>
Co-authored-by: enoch85 <4511254+enoch85@users.noreply.github.com>
Co-authored-by: enoch85 <4511254+enoch85@users.noreply.github.com>
Co-authored-by: enoch85 <4511254+enoch85@users.noreply.github.com>
Co-authored-by: enoch85 <4511254+enoch85@users.noreply.github.com>
Co-authored-by: enoch85 <4511254+enoch85@users.noreply.github.com>
Co-authored-by: enoch85 <4511254+enoch85@users.noreply.github.com>
Co-authored-by: enoch85 <4511254+enoch85@users.noreply.github.com>
Copilot AI changed the title [WIP] Update documentation for next Maintainerr release Document download-client drift for the next release Sep 11, 2026
Copilot AI requested a review from enoch85 September 11, 2026 21:02
@enoch85

enoch85 commented Sep 11, 2026

Copy link
Copy Markdown
Collaborator

@copilot Please update docs from the latest app changes.

Co-authored-by: enoch85 <4511254+enoch85@users.noreply.github.com>

Copilot AI commented Sep 11, 2026

Copy link
Copy Markdown
Contributor Author

@copilot Please update docs from the latest app changes.

Updated in 2ad1a0f with the latest app-side follow-up: the Configuration docs now note that switching download client types clears the URL field because qBittorrent and Transmission use different URL shapes.

@enoch85
enoch85 marked this pull request as ready for review September 11, 2026 22:56
@enoch85
enoch85 merged commit f69fb66 into main Sep 11, 2026
3 checks passed
@enoch85
enoch85 deleted the copilot/update-docs-for-maintainerr-release branch September 11, 2026 22:59
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.

Docs drift - updates needed for the next Maintainerr release

2 participants