Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: use "Visual diff" for marketing "Doc Diff" #11860

Merged
merged 1 commit into from
Dec 17, 2024
Merged

Docs: use "Visual diff" for marketing "Doc Diff" #11860

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/user/addons.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Read the Docs Addons
They are used in the rendered documentation,
and can be accessed via hotkeys or on screen UI elements.

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

:doc:`Link previews </link-previews>`
Expand Down
2 changes: 1 addition & 1 deletion docs/user/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Read the Docs: documentation simplified
:caption: Reading documentation

/downloadable-documentation
/doc-diff
/visual-diff
/link-previews
/guides/embedding-content
/server-side-search/index
Expand Down
6 changes: 3 additions & 3 deletions docs/user/pull-requests.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ Pull request notifications
A pull request notifications is shown at the top of preview pages,
which let readers know they aren't viewing an active version of the project.

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

Press ``d`` to toggle between DocDiff and normal pull request preview.
Press ``d`` to toggle between Visual diff and normal pull request preview.

.. seealso::

Expand Down
22 changes: 11 additions & 11 deletions docs/user/doc-diff.rst → docs/user/visual-diff.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
DocDiff
=======
Visual diff
===========

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

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

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

Example of DocDiff
Example of Visual diff

Enabling DocDiff
----------------
Enabling Visual diff
--------------------

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

Troubleshooting DocDiff
-----------------------
Troubleshooting Visual diff
---------------------------

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

There are also some known issues that currently don't display properly:
Expand Down
Loading