Skip to content

Commit 3b95aa7

Browse files
Joanne LeeJoanne Lee
Joanne Lee
authored and
Joanne Lee
committed
feat(viz-diff-doc): update viz diff doc
1 parent 9d48899 commit 3b95aa7

File tree

5 files changed

+25
-9
lines changed

5 files changed

+25
-9
lines changed

docs/user/img/addons-docdiff.gif

-206 KB
Binary file not shown.
62.7 KB
Loading

docs/user/img/viz-diff-configs.gif

316 KB
Loading

docs/user/img/viz-diff-nav.gif

772 KB
Loading

docs/user/visual-diff.rst

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,41 @@ showing what has changed between the ``latest`` version and the active :doc:`pul
66

77
Visual diff allows you to quickly review changes visually,
88
and focus your review on what has changed in the current page.
9+
`
10+
Using Visual diff
11+
-----------------
912

10-
.. figure:: /img/addons-docdiff.gif
11-
:width: 80%
13+
Visual diff is enabled by `default` and it's only available on pull request builds.
1214

13-
Example of Visual diff
15+
Once enabled, a new UI element appears at the top-right of the page showing a dropdown selector containing all the files that have changed between the base version (e.g. ``latest``) and the current pull request build.
16+
The pull request build information will also be accessible as a pop-up notification on initial load or from the hyperlink in the pinned selector element.
1417

15-
Using Visual diff
16-
-----------------
18+
.. figure:: /img/screenshot-viz-diff-ui.png
19+
:width: 80%
1720

18-
Visual diff is enabled by default and it's only available on pull request builds.
19-
Once enabled, a new UI element appears at the top-right of the page showing a dropdown selector containing
20-
all the files that have changed between the base version (e.g. ``latest``) and the current pull request build.
2121

2222
You can select any of those files from the dropdown to jump directly into that page.
2323
Once there, you can toggle it on/off by pressing the :guilabel:`Show diff` link from the UI element, or pressing the `d` key if you have hotkeys enabled.
2424
Visual diff will show all the sections that have changed and their differences highlighted with red/green background colors.
2525
Then you can jump between each of these chunks by clinking on the up/down arrows.
2626

27+
.. figure:: /img/viz-diff-nav.gif
28+
:width: 80%
29+
30+
Navigating visual diff
31+
32+
33+
Configuring Visual Diff
34+
-----------------
35+
2736
All the available configuration for the visual diff addon can be found under :guilabel:`Settings > Addons > Visual diff` in the :term:`dashboard`.
37+
You can choose to disable/enable the `Visual diff` feature on an per-project basis.
38+
Visual diff can also ignore files by specifying these files under `File tree diff`, regex supported.
39+
40+
.. figure:: /img/viz-diff-configs.gif
41+
:width: 80%
42+
43+
Configurations
2844

2945

3046
Troubleshooting Visual diff
@@ -36,6 +52,6 @@ so ensure you are on a page that has changed in the current pull request.
3652
There are also some known issues that currently don't display properly.
3753
We are working to improve the UX, but so far we've found the following issues:
3854

39-
* **Tables** are shown to have changes when they may not have changed. This is due to do subtly in how HTML tables are rendered, and will be fixed in a future version.
55+
* **Tables** are shown to have changes when they may not have changed. This is due to subtle variations in how HTML tables are rendered, and will be fixed in a future version.
4056
* **Invisible changes** sometimes are marked as diff due than the underlying HTML changing, but there is no visual change. This could happen if the URL of a link changed, for example.
4157
* **Chunks background is incorrect** when we are unable to detect the correct main parent element for the chunk.

0 commit comments

Comments
 (0)