From 67f74d40a662af83d7d95929a0af4ea6bf168108 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= <sporiff@funkwhale.audio>
Date: Fri, 5 Apr 2024 11:13:25 +0000
Subject: [PATCH] Add ListenBrainz sync documentation

Part-of: <https://dev.funkwhale.audio/funkwhale/funkwhale/-/merge_requests/2658>
---
 docs/user/plugins/listenbrainz.md | 49 +++++++++++++++++++++++++++++--
 1 file changed, 47 insertions(+), 2 deletions(-)

diff --git a/docs/user/plugins/listenbrainz.md b/docs/user/plugins/listenbrainz.md
index d15cbfe7b..d2b828feb 100644
--- a/docs/user/plugins/listenbrainz.md
+++ b/docs/user/plugins/listenbrainz.md
@@ -19,8 +19,8 @@ The **ListenBrainz** plugin enables you to submit ({term}`scrobble<Scrobbling>`)
 
 :::
 
-:::{tab-item} Desktop
-:sync: desktop
+:::{tab-item} Mobile
+:sync: mobile
 
 1. Log in to your account.
 2. Select the cog icon ({fa}`cog`) or your avatar to open the {guilabel}`Options` menu.
@@ -36,3 +36,48 @@ The **ListenBrainz** plugin enables you to submit ({term}`scrobble<Scrobbling>`)
 ::::
 
 That's it! You've set up the **ListenBrainz** plugin. When you listen to tracks, the plugin sends the information to ListenBrainz.
+
+## Enable data synchronization
+
+The ListenBrainz plugin supports synchronizing listenings and track favorites with Funkwhale. To enable support for synchronization:
+
+::::{tab-set}
+
+:::{tab-item} Desktop
+:sync: desktop
+
+1. Log in to your account.
+2. Select the cog icon ({fa}`cog`) or your avatar to expand the user menu.
+3. Select {guilabel}`Settings`.
+4. Scroll down to the {guilabel}`Plugins` section.
+5. Select {guilabel}`Manage plugins`.
+6. Find the {guilabel}`ListenBrainz` plugin.
+7. Enter {guilabel}`Your ListenBrainz user name`. You can find this on your ListenBrainz profile.
+8. Select the data you want to synchronize. The following options are available:
+   - {guilabel}`Enable listenings submission to ListenBrainz`: submit your Funkwhale listens to ListenBrainz.
+   - {guilabel}`Enable listenings sync`: pull listening data from ListenBrainz into Funkwhale.
+   - {guilabel}`Enable favorite submission to ListenBrainz services`: submit your Funkwhale favorites activity to ListenBrainz.
+   - {guilabel}`Enable favorite sync`: pull favorites data from ListenBrainz into Funkwhale.
+9. Select {guilabel}`Save`.
+
+:::
+
+:::{tab-item} Mobile
+:sync: mobile
+
+1. Log in to your account.
+2. Select the cog icon ({fa}`cog`) or your avatar to open the {guilabel}`Options` menu.
+3. Select {guilabel}`Settings`.
+4. Scroll down to the {guilabel}`Plugins` section.
+5. Select {guilabel}`Manage plugins`.
+6. Find the {guilabel}`ListenBrainz` plugin.
+7. Enter {guilabel}`Your ListenBrainz user name`. You can find this on your ListenBrainz profile.
+8. Select the data you want to synchronize. The following options are available:
+   - {guilabel}`Enable listenings submission to ListenBrainz`: submit your Funkwhale listens to ListenBrainz.
+   - {guilabel}`Enable listenings sync`: pull listening data from ListenBrainz into Funkwhale.
+   - {guilabel}`Enable favorite submission to ListenBrainz services`: submit your Funkwhale favorites activity to ListenBrainz.
+   - {guilabel}`Enable favorite sync`: pull favorites data from ListenBrainz into Funkwhale.
+9. Select {guilabel}`Save`.
+
+:::
+::::