Skip to content

Commit 2fa9aed

Browse files
authored
Docs: use "Visual diff" for marketing "Doc Diff" (#11860)
Related #11838 <!-- readthedocs-preview docs start --> --- :books: Documentation previews :books: - User's documentation (`docs`): https://docs--11860.org.readthedocs.build/en/11860/ <!-- readthedocs-preview docs end --> <!-- readthedocs-preview dev start --> - Developer's documentation (`dev`): https://dev--11860.org.readthedocs.build/en/11860/ <!-- readthedocs-preview dev end -->
1 parent fd671d9 commit 2fa9aed

File tree

4 files changed

+16
-16
lines changed

4 files changed

+16
-16
lines changed

docs/user/addons.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Read the Docs Addons
55
They are used in the rendered documentation,
66
and can be accessed via hotkeys or on screen UI elements.
77

8-
:doc:`DocDiff </doc-diff>`
8+
:doc:`Visual diff </visual-diff>`
99
Highlight changed output from pull requests
1010

1111
:doc:`Link previews </link-previews>`

docs/user/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Read the Docs: documentation simplified
5959
:caption: Reading documentation
6060

6161
/downloadable-documentation
62-
/doc-diff
62+
/visual-diff
6363
/link-previews
6464
/guides/embedding-content
6565
/server-side-search/index

docs/user/pull-requests.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ Pull request notifications
2828
A pull request notifications is shown at the top of preview pages,
2929
which let readers know they aren't viewing an active version of the project.
3030

31-
:doc:`DocDiff </doc-diff>`
32-
DocDiff shows proposed changes by visually highlighting the differences between the current pull request and the latest version of the project's documentation.
31+
:doc:`Visual diff </visual-diff>`
32+
Visual diff shows proposed changes by visually highlighting the differences between the current pull request and the latest version of the project's documentation.
3333

34-
Press ``d`` to toggle between DocDiff and normal pull request preview.
34+
Press ``d`` to toggle between Visual diff and normal pull request preview.
3535

3636
.. seealso::
3737

docs/user/doc-diff.rst renamed to docs/user/visual-diff.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
1-
DocDiff
2-
=======
1+
Visual diff
2+
===========
33

4-
DocDiff allows you to see a visual :term:`diff` on a documentation page,
4+
Visual diff allows you to see a visual :term:`diff` on a documentation page,
55
showing what has changed between the ``latest`` version and the active :doc:`pull request </pull-requests>`.
66

7-
DocDiff allows you to quickly review changes visually,
7+
Visual diff allows you to quickly review changes visually,
88
and focus your review on what has changed in the current page.
99

1010
.. figure:: /img/addons-docdiff.gif
1111
:width: 80%
1212

13-
Example of DocDiff
13+
Example of Visual diff
1414

15-
Enabling DocDiff
16-
----------------
15+
Enabling Visual diff
16+
--------------------
1717

18-
DocDiff is only enabled on pull request builds,
18+
Visual diff is only enabled on pull request builds,
1919
and can be toggled on and off with the ``d`` hotkey.
2020

21-
Troubleshooting DocDiff
22-
-----------------------
21+
Troubleshooting Visual diff
22+
---------------------------
2323

24-
DocDiff only works if there are changes on the page,
24+
Visual diff only works if there are changes on the page,
2525
so ensure you are on a page that has changed in the current pull request.
2626

2727
There are also some known issues that currently don't display properly:

0 commit comments

Comments
 (0)