From 7c550eb6e1f98919a2e10ee338b47566f9ac1d3f Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Mon, 16 Dec 2024 15:58:32 +0100 Subject: [PATCH] Docs: use "Visual diff" for marketing "Doc Diff" Related https://github.com/readthedocs/readthedocs.org/pull/11838 --- docs/user/addons.rst | 2 +- docs/user/index.rst | 2 +- docs/user/pull-requests.rst | 6 +++--- docs/user/{doc-diff.rst => visual-diff.rst} | 22 ++++++++++----------- 4 files changed, 16 insertions(+), 16 deletions(-) rename docs/user/{doc-diff.rst => visual-diff.rst} (60%) diff --git a/docs/user/addons.rst b/docs/user/addons.rst index ca82e548fd9..46af2d3829d 100644 --- a/docs/user/addons.rst +++ b/docs/user/addons.rst @@ -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:`Visual diff ` Highlight changed output from pull requests :doc:`Link previews ` diff --git a/docs/user/index.rst b/docs/user/index.rst index 7c1e47dc878..8688a89b0df 100644 --- a/docs/user/index.rst +++ b/docs/user/index.rst @@ -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 diff --git a/docs/user/pull-requests.rst b/docs/user/pull-requests.rst index afa8a16104b..2f4a89ce877 100644 --- a/docs/user/pull-requests.rst +++ b/docs/user/pull-requests.rst @@ -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 ` - 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 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:: diff --git a/docs/user/doc-diff.rst b/docs/user/visual-diff.rst similarity index 60% rename from docs/user/doc-diff.rst rename to docs/user/visual-diff.rst index 4b2b2209564..04aeb1b53a9 100644 --- a/docs/user/doc-diff.rst +++ b/docs/user/visual-diff.rst @@ -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 `. -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: