Skip to content

Commit 691aa64

Browse files
joleeclJoanne Leeericholscher
authored
feat(viz-diff-doc): update viz diff doc (#12185)
Closes #12150 <!-- readthedocs-preview docs start --> --- :books: Documentation previews :books: - User's documentation (`docs`): https://docs--12185.org.readthedocs.build/12185/ <!-- readthedocs-preview docs end --> <!-- readthedocs-preview dev start --> - Developer's documentation (`dev`): https://dev--12185.org.readthedocs.build/12185/ <!-- readthedocs-preview dev end --> --------- Co-authored-by: Joanne Lee <[email protected]> Co-authored-by: Eric Holscher <[email protected]>
1 parent 382877a commit 691aa64

File tree

3 files changed

+16
-11
lines changed

3 files changed

+16
-11
lines changed

docs/user/img/addons-docdiff.gif

-206 KB
Binary file not shown.
62.7 KB
Loading

docs/user/visual-diff.rst

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,30 @@ showing what has changed between the ``latest`` version and the active :doc:`pul
77
Visual diff allows you to quickly review changes visually,
88
and focus your review on what has changed in the current page.
99

10-
.. figure:: /img/addons-docdiff.gif
11-
:width: 80%
12-
13-
Example of Visual diff
14-
1510
Using Visual diff
1611
-----------------
1712

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.
13+
Visual diff is enabled by default and is only available on pull request builds.
14+
It works by comparing the current page with the default version of the documentation (e.g. where `/` redirects to).
15+
16+
When Visual diff is enabled,
17+
a new UI element appears at the top right of the page showing a dropdown selector containing all the files that have changed in that pull request build.
18+
19+
.. figure:: /img/screenshot-viz-diff-ui.png
20+
:width: 80%
2121

2222
You can select any of those files from the dropdown to jump directly into that page.
23-
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.
23+
Once there, you can toggle Visual Diff on and off by pressing the :guilabel:`Show diff` link from the UI element, or pressing the `d` key if you have hotkeys enabled.
24+
2425
Visual diff will show all the sections that have changed and their differences highlighted with red/green background colors.
2526
Then you can jump between each of these chunks by clinking on the up/down arrows.
2627

27-
All the available configuration for the visual diff addon can be found under :guilabel:`Settings > Addons > Visual diff` in the :term:`dashboard`.
28+
Configuring Visual Diff
29+
-----------------------
2830

31+
All the available configuration for the visual diff addon can be found under :guilabel:`Settings > Addons > Visual diff` in the :term:`dashboard`.
32+
You can choose to disable/enable the `Visual diff` feature on a per project basis.
33+
Visual diff can also ignore files by specifying these files under `File tree diff`, regex supported.
2934

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

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.
44+
* **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.
4045
* **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.
4146
* **Chunks background is incorrect** when we are unable to detect the correct main parent element for the chunk.

0 commit comments

Comments
 (0)