diff --git a/docs/help/contents/_include/static/merge-conflicts-resolution-screen-2.png b/docs/help/contents/_include/static/merge-conflicts-resolution-screen-2.png new file mode 100644 index 000000000..b24214c05 Binary files /dev/null and b/docs/help/contents/_include/static/merge-conflicts-resolution-screen-2.png differ diff --git a/docs/help/contents/_include/static/merge-conflicts-resolution-screen-mobile-2.png b/docs/help/contents/_include/static/merge-conflicts-resolution-screen-mobile-2.png new file mode 100644 index 000000000..f43fcf111 Binary files /dev/null and b/docs/help/contents/_include/static/merge-conflicts-resolution-screen-mobile-2.png differ diff --git a/docs/help/contents/_include/static/merge-conflicts-resolution-screen-mobile.png b/docs/help/contents/_include/static/merge-conflicts-resolution-screen-mobile.png new file mode 100644 index 000000000..82ebf039e Binary files /dev/null and b/docs/help/contents/_include/static/merge-conflicts-resolution-screen-mobile.png differ diff --git a/docs/help/contents/_include/static/merge-conflicts-resolution-screen.png b/docs/help/contents/_include/static/merge-conflicts-resolution-screen.png new file mode 100644 index 000000000..5f35dedab Binary files /dev/null and b/docs/help/contents/_include/static/merge-conflicts-resolution-screen.png differ diff --git a/docs/help/contents/faqs/README.md b/docs/help/contents/faqs/README.md new file mode 100644 index 000000000..95241a8b3 --- /dev/null +++ b/docs/help/contents/faqs/README.md @@ -0,0 +1 @@ +# FAQs diff --git a/docs/help/contents/faqs/what-are-merge-conflicts.md b/docs/help/contents/faqs/what-are-merge-conflicts.md new file mode 100644 index 000000000..5aeb3ce72 --- /dev/null +++ b/docs/help/contents/faqs/what-are-merge-conflicts.md @@ -0,0 +1,67 @@ +--- +title: What are merge conflicts? +description: Merge conflicts occur when two or more devices edit the same note and then attempt to sync these changes. Since each device has a different version of the note, Notesnook cannot automatically determine which version should take precedence, resulting in a merge conflict. +--- + +# What are merge conflicts? + +Merge conflicts occur when two or more devices edit the same note and then attempt to sync these changes. Since each device has a different version of the note, Notesnook cannot automatically determine which version should take precedence, resulting in a merge conflict. + +### Example: + +Let’s say you’re using Notesnook on both your laptop and smartphone. You edit a note on your laptop making a lot of changes. Later, while commuting, you remember something important and edit the same note on your smartphone. When both devices eventually reconnect to the internet and sync, Notesnook detects that there are two different versions of the same note and triggers a merge conflict. + +## Why do merge conflicts happen? + +Merge conflicts happen because Notesnook cannot safely figure out which version of the name you want to keep. Unlike some apps that prioritize the most recent changes or attempt to merge content automatically (which can result in loss of important data or unwanted changes), Notesnook ensures you have full control over which version of a note you want to keep. + +> info Both edits must be at least a minute apart +> +> The changes on both devices must be at least a minute apart for a merge conflict to occur. For example, if you are editing on both devices simultaneously (and both devices have a working sync), a merge conflict will NOT occur. + +### Why doesn't Notesnook automatically resolve merge conflicts? + +1. Automatic conflict resolution can lead to unintended data loss. For example, if both versions of a note contain unique but crucial information, merging them automatically might result in losing an important part of the information. +2. By allowing you to manually resolve conflicts, you can review each version of the note and decide which one is correct or if you want to keep both (i.e. both versions contain important information). + +## Where do I find the conflicted notes? + +Conflicted notes appear at the very top of your notes list. + +1. Navigate to Notes +2. If you have any conflicts, you'll see them under the **Conflicted** group + +## How to resolve merge conflicts + +### [Desktop/Web](#/tab/web) + +To resolve a merge conflict on your desktop or web app, follow these steps: + +1. Locate the conflicted note at the top of your notes list. +2. Click on the note to open the conflict resolution screen. +3. On the conflict resolution screen, you’ll see two versions of your note side by side: + 1. **Current Note** is the version from the device you are using. + 2. **Incoming Note** is the version coming from the other device. + ![](/static/merge-conflicts-resolution-screen.png) + 3. The red and green highlights on the left side show the changes you made. Red indicates deletions and green indicates additions. +4. Review both versions and decide which one you want to keep. +5. Click the **Keep** button on the version you want to retain. +6. Click the **Discard** button on the version you don’t want to keep, or press **Save a Copy** if you want to keep both versions. + ![](/static/merge-conflicts-resolution-screen-2.png) + +### [Mobile](#/tab/mobile) + +To resolve a merge conflict on your mobile device, follow these steps: + +1. Locate the conflicted note at the top of your notes list. +2. Tap on the note to open the conflict resolution screen. +3. On the conflict resolution screen, you’ll see two versions of your note, one above the other: + 1. **This Device** is the version from the device you are using. + 2. **Incoming** is the version coming from the other device. +

drawing

+4. Review both versions and decide which one you want to keep. +5. Press the **Keep** button on the version you want to retain. +6. Press the **Discard** button on the version you don’t want to keep, or press **Save a Copy** if you want to keep both versions. +

drawing

+ +--- diff --git a/docs/help/contents/merge-conflicts.md b/docs/help/contents/merge-conflicts.md deleted file mode 100644 index de35d7e23..000000000 --- a/docs/help/contents/merge-conflicts.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: Merge Conflicts -description: Merge conflicts occur when there are conflicting note edits on different devices for the same note. ---- - -# Merge Conflicts - -## Why Merge Conflicts occur? - -Merge conflicts occur when there are conflicting note edits on different devices for the same note. - -## How Merge Conflicts occur? - -Lets suppose that you have two devices running Notesnook: - -1. A desktop -2. A mobile device - -Suppose that one of your devices is offline. Now if you made edits to one of your (same)notes on both your devices and **synched changes** a merge conflict will occur. - -> info -> -> In order for a merge conflict to occur the changes on the (same)note on both devices should occur in more than a minute - -## Where do Merge conflicts show - -The conflicted notes appear at the very top of the notes list. Just navigate to the Notes page and you will see them right away (If there are any). - -## How to Resolve Merge Conflicts - -# [Desktop/Web](#/tab/web) - -Follow these steps to resolve a Merge Conflict: - -1. Go to the conflicted note. It appears at the top of your note list. -2. Open the note. This will take you to a conflict resolution screen. -3. On the conflict resolution screen two versions of your note will appear side by side. One will be from the device you are using (Current Note) and one will be from the server(Incomming Note). - -![](https://github.com/user-attachments/assets/7790bcd3-e87f-4a5e-a8e6-3fba1b3f3ab3) - -4. Go through both versions and choose which one you want to keep. -5. Press the Keep button on the note you want to keep. -6. Press Discard button on the note you don't want to keep (you can also press the Save a Copy button if you want to keep it too). - -![](https://github.com/user-attachments/assets/58558f0e-6bf1-486d-a183-702dba54dcaf) - -# [Mobile](#/tab/mobile) - -Follow these steps to resolve a Merge Conflict: - -1. Go to the conflicted note. It appears at the top of your note list. -2. Open the note. This will take you to a conflict resolution screen. -3. On the Coflict Resolution Screen 2 versions of your note will appear above and below. One will be from the device you are using (Current Note) and one will be from the server(Incomming Note). - -drawing - -4. Go through both versions and choose which one you want to keep. -5. Press the Keep button on the note you want to keep. -6. And Discard button on the note you don't want to keep (you can also press the Save a Copy button if you want to keep it too). - -drawing - ---- diff --git a/docs/help/docgen.yaml b/docs/help/docgen.yaml index 2dcda3a13..524d66578 100644 --- a/docs/help/docgen.yaml +++ b/docs/help/docgen.yaml @@ -79,4 +79,6 @@ navigation: - path: custom-themes/create-a-theme-with-theme-builder.md - path: custom-themes/install-a-theme-from-file.md - path: custom-themes/publish-a-theme.md - - path: merge-conflicts.md + - path: faqs + children: + - path: faqs/what-are-merge-conflicts.md