Skip to content

Commit 8c0c195

Browse files
authored
Merge pull request #7045 from FlowFuse/snapshot-docs-update
docs: update snapshot comparison section with property and code diff details
2 parents 4a122ea + d158cfd commit 8c0c195

3 files changed

Lines changed: 18 additions & 3 deletions

File tree

653 KB
Loading
549 KB
Loading

docs/user/snapshots.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,22 @@ _Screenshot to an example flow preview for a Snapshot in FlowFuse_
250250

251251
### Comparing Snapshots
252252

253-
From any Snapshots tab, you can compare two snapshots by selecting the Snapshot's actions, then selecting "Compare Snapshots". This will open a new Dialog with option to chose a second snapshot to compare with.
253+
From any Snapshots tab, you can compare two snapshots by selecting the Snapshot's action,
254+
then selecting "Compare Snapshots". This will open a new dialog with the option to choose
255+
a second snapshot to compare with.
254256

255-
![Compare snapshots](images/snapshots/compare.png)
256-
_Screenshot demonstrating the compare snapshots feature_
257+
In the top left, a sidebar lists every changed, added, and deleted node, showing what action
258+
occurred for each. The flow canvas highlights the selected node and scrolls to it
259+
automatically, giving you a visual indication of where the change is in your flow. The right
260+
side shows the property and code changes for the affected node. You can step through them
261+
one at a time using the **Prev / Next** buttons. For each change you can see:
262+
263+
- **Property diffs** - Each changed property is shown inline with the old and new value side by side, with red `-` for removed and green `+` for added
264+
265+
![Screenshot showing property-level diff with old and new values displayed side by side](images/snapshots/snapshot-diff-prop-change.png)
266+
_Screenshot showing property-level diff with old and new values displayed side by side_
267+
268+
- **Code diffs** - For multiline properties — for example in function and template nodes — code changes appear as a line-level diff with red `-` for removed lines and green `+` for added, the same format you'd expect from a git diff
269+
270+
![Screenshot showing a code diff for a function node with red and green line-level changes](images/snapshots/snapshot-diff-code-change.png)
271+
_Screenshot showing a code diff for a function node with red and green line-level changes_

0 commit comments

Comments
 (0)