From 40417aecf7607300320b9fb0e7bf7a74252228be Mon Sep 17 00:00:00 2001 From: Arnab Chakraborty <11457760+Rocky43007@users.noreply.github.com> Date: Tue, 18 Jun 2024 14:06:25 +0530 Subject: [PATCH] wip --- docs/product/guides/folder-sync.mdx | 5 - docs/product/guides/library-sync.mdx | 152 +++++++++++++++++++++++++++ 2 files changed, 152 insertions(+), 5 deletions(-) delete mode 100644 docs/product/guides/folder-sync.mdx create mode 100644 docs/product/guides/library-sync.mdx diff --git a/docs/product/guides/folder-sync.mdx b/docs/product/guides/folder-sync.mdx deleted file mode 100644 index 18f1b64a5..000000000 --- a/docs/product/guides/folder-sync.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -index: 100 ---- - -# Folder Sync diff --git a/docs/product/guides/library-sync.mdx b/docs/product/guides/library-sync.mdx new file mode 100644 index 000000000..d1ac3f85d --- /dev/null +++ b/docs/product/guides/library-sync.mdx @@ -0,0 +1,152 @@ +--- +index: 100 +--- + +# Library Sync + + + +Syncing libraries across devices is one of the core features of Spacedrive. There are two methods of syncing available in Spacedrive: + +- **Peer to Peer** - Syncing your library across devices on the same local network, without the need for an internet connection. +- **Cloud Sync** - Utilizing the Spacedrive network to sync your library across devices over the internet, securely and privately. + + + + +## Setting up Cloud Sync + +### Desktop + +1. Open the Settings view by clicking on the gear icon in the bottom left corner of the sidebar. + +[Spacedrive Sync settings from the Settings view (TODO -> DESKTOP)](/cloud/desktop/sync-settings.webp) + +2. Click on the "Sync" tab. + +3. Click on the "Start Backfill" [NOTE: Confirm @Rocky43007] button to begin setting up your database for syncing. + + + +4. Once the backfill process is complete, you will then be able to enable syncing by heading to the "Cloud" tab. + +[Spacedrive Cloud settings from the Settings view (TODO -> DESKTOP)](/cloud/desktop/cloud-settings.webp) [NOTE: Animation/Video?] + +5. You will be prompted to log in to your Spacedrive account. If you do not have an account, you can create one by clicking on the "Sign Up" button. + +6. After logging in, you will be able to enable syncing by clicking on the "Connect to Spacedrive Cloud" button. + +7. Your library will now be synced across devices that are connected to your Spacedrive account. + +### Mobile + +1. Open the Settings view by clicking on the gear icon/settings button in the bottom navigation bar. + +[Spacedrive Sync settings from the Settings view (TODO -> MOBILE)](/cloud/mobile/sync-settings.webp) + +2. Click on the "Sync" tab. + +3. Click on the "Start Backfill" [NOTE: Confirm @Rocky43007] button to begin setting up your database for syncing. + + + +4. Once the backfill process is complete, you will then be able to enable syncing by heading to the "Cloud" tab. + +[Spacedrive Cloud settings from the Settings view (TODO -> MOBILE)](/cloud/mobile/cloud-settings.webp) [NOTE: Animation/Video?] + +5. You will be prompted to log in to your Spacedrive account. If you do not have an account, you can create one by clicking on the "Sign Up" button. + +6. After logging in, you will be able to enable syncing by clicking on the "Connect to Spacedrive Cloud" button. + +7. Your library will now be synced across devices that are connected to your Spacedrive account. + +## Adding Synced Libraries + +Once you have set up Cloud Sync, you can add synced libraries to your devices by following these steps: + +### Desktop via Settings + +1. Open the Settings view by clicking on the gear icon in the bottom left corner of the sidebar. + +[Spacedrive Sync settings from the Settings view (TODO -> DESKTOP)](/cloud/desktop/sync-settings.webp) + +2. Click on the "Libraries" tab. In the top right corner, click on the "Join Library" button. + +3. Select the library you want to join from the list of available libraries in the dropdown. + +[Joining Library Modal (TODO -> DESKTOP)](/cloud/desktop/join-library-settings.webp) + +4. Click on the "Join" button to add the library to your device. + +### Desktop via Library Selector in sidebar + +1. Click on the current library name in the sidebar to open the Library Selector. + +2. Click on the "Join Library" button. + +[Joining Library in Settings Image (TODO -> DESKTOP)](/cloud/desktop/join-library-sidebar.webp) + +3. Select the library you want to join from the list of available libraries in the dropdown. + +4. Click on the "Join" button to add the library to your device. + +### Mobile + +1. Open the Library Selector by clicking on the current library name in the sidebar. + +2. Click on the "Import Library" button. + +[Import Library in Settings Image (TODO -> MOBILE)](/cloud/mobile/import-library-sidebar.webp) + +3. Select the library you want to import from the list of available libraries. + +4. Click on the "Join" button to add the library to your device. + +[Joining Library Modal (TODO -> MOBILE)](/cloud/mobile/join-library-settings.webp) + +## Removing Synced Libraries + +To remove a synced library from your device, follow these steps: + +### Desktop + +1. Open the Settings view by clicking on the gear icon in the bottom left corner of the sidebar. + +2. Click on the "Libraries" tab. + +3. Click on the "Delete Library" button next to the library you want to remove. + +[Deleting Library in Settings Image (TODO -> DESKTOP)](/cloud/desktop/delete-library-settings.webp) + +4. Confirm the deletion by clicking on the "Delete" button in the confirmation dialog. [NOTE: Confirm @Rocky43007] + +### Mobile + +1. Open the Library Selector by clicking on the current library name in the sidebar. + +2. Click on "Manage Library" in the Library Selector. + +3. Click on the "Delete Library" button next to the library you want to remove. + +[Deleting Library in Settings Image (TODO -> MOBILE)](/cloud/mobile/delete-library-sidebar.webp) + + + + + + + +