update(v6-migration): update qbit flatLinking recommendations (#31)

* update(v6-migration): update qbit flatLinking recommendations * Apply suggestions from code review Co-authored-by: zakary <[email protected]> --------- Co-authored-by: zakary <[email protected]>
cross-seed · May 14, 2024 · 1cadf65 · 1cadf65
1 parent 77c5c3a
commit 1cadf65
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 8 deletions.
diff --git a/docs/basics/options.md b/docs/basics/options.md
@@ -1272,8 +1272,17 @@ searchLimit: 150,
 This feature is a v6 only feature.
 :::
 
+:::caution Be Advised
+qBittorrent users using an external program or script, such as qbit_manage, to force
+AutoTMM on torrents (e.g. to apply share limits automatically) will need to enable
+`flatLinking` or modify your workflow accordingly.
+
+[**Read more about specific usage**](v6-migration.md#qbittorrent)
+:::
+
 Set this to `true` to use the flat-folder style linking previously used in v5. This option
 will otherwise link any matches to a tracker-specific folder inside of `linkDir` (if set).
+This prevents cross seeds from conflicting with each other.
 
 With `flatLinking: false` (default):
 
@@ -1287,26 +1296,21 @@ linkDir/
 		Pack/
 			Pack.1.mkv
 			Pack.2.mkv
+		Video.mkv
 ```
 
 With `flatLinking: true`:
 
 ```
 linkDir/
-	Video.mkv
+	Video.mkv   <--- Both TrackerA and TrackerB cross seeds share the same file
 	Video2/
 		Video2.mkv
 	Pack/
 		Pack.1.mkv
 		Pack.2.mkv
 ```
 
-:::caution Be Advised
-If you are using `qbitmanage` and/or AutoTorrentManagement in any capacity, it is highly recommended that you enable this options.
-
-[**Read why**](../v6-migration.md#qbittorrent)
-:::
-
 #### `flatLinking` Examples (CLI)
 
 ```shell

diff --git a/docs/v6-migration.md b/docs/v6-migration.md
@@ -93,7 +93,9 @@ During this transitional process, you can get support [**via Discord**](https://
 
 Due to the limitations in place with qBittorrent and Auto Torrent Management's behavior, we've introduced a new option in support of the feature-sets and changes we have added.
 
-If you are using Auto Torrent Management (AutoTMM) **in any capacity, we strongly recommend** that you enable [`flatLinking`](./basics/options.md#flatlinking) to acheive the matching and linking behavior we've added to v6. You will still be able to take advantage of the [matching enhancements](#partial-matching) in v6 with your searches.
+If you are using an external program or script, such as qbit_manage, to force Auto Torrent Management (AutoTMM) on your torrents, **you must** enable [`flatLinking`](./basics/options.md#flatlinking) for `cross-seed` linking to work. If the program/script can ignore modifying AutoTMM on torrents with the `cross-seed` tag, then you **should** enable that feature and set `flatLinking: false`. 
+
+Even with `flatLinking: true`, you can still take advantage of the [matching enhancements](#partial-matching) in v6 with your searches. However **we strongly recommend** that you consider your AutoTMM usage and make changes in your config and workflow to support `flatLinking: false` to prevent cross-seeds from conflicting.
 
 `cross-seed` will inject all linked torrents directly to the [`linkCategory`](./basics/options.md#linkcategory) if linking is possible, otherwise direct torrent matches will behave the same as they did in v5.