Skip to content

Commit 5e74709

Browse files
pjfanericholscher
andauthored
Link previews docs update (#12187)
<!-- readthedocs-preview docs start --> --- :books: Documentation previews :books: - User's documentation (`docs`): https://docs--12187.org.readthedocs.build/12187/ <!-- readthedocs-preview docs end --> <!-- readthedocs-preview dev start --> - Developer's documentation (`dev`): https://dev--12187.org.readthedocs.build/12187/ <!-- readthedocs-preview dev end --> --------- Co-authored-by: Eric Holscher <[email protected]>
1 parent c34de45 commit 5e74709

File tree

3 files changed

+14
-5
lines changed

3 files changed

+14
-5
lines changed

docs/user/addons.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ Configuring Read the Docs Addons
3737

3838
Individual configuration options for each addon are available in :guilabel:`Settings`.
3939

40-
#. Go to the new :term:`dashboard`:
40+
#. Go to the new :term:`dashboard`.
4141
#. Click on a project name.
42-
#. Go to :guilabel:`Settings`
42+
#. Go to :guilabel:`Settings`.
4343
#. In the left bar, go to :guilabel:`Addons`.
4444
#. Configure each Addon individually.
4545

docs/user/link-previews.rst

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,26 @@ so you can keep your context while reading but learn more from other resources.
1010

1111
Example of link previews addon
1212

13+
Link previews will only be generated for internal links--links that point to pages within your documentation site.
14+
No link previews will be generated for links to external sites or links that appear outside of the primary content of the documentation page (eg. nav bars).
1315

16+
You can see an example of a link preview by hovering over the following link: :doc:`Addons </addons>`.
1417

1518
Enabling link previews
1619
----------------------
1720

18-
In your dashboard, you can go to the links preview tag in :guilabel:`Settings > Addons > Link previews` and enable it.
21+
#. Go to the new :term:`dashboard`.
22+
#. Click on a project name.
23+
#. Go to :guilabel:`Settings`, then in the left bar, go to :guilabel:`Addons`.
24+
#. Go to :guilabel:`Link previews` and check :guilabel:`Enabled`.
25+
#. Save your settings -- a rebuild of your project isn't required!
1926

2027
Troubleshooting link previews
2128
-----------------------------
2229

2330
We perform some heuristic to detect the documentation tool used to generate the page based on its HTML structure.
2431
This auto-detection may fail, resulting in the content rendered inside the popup being incorrect.
25-
If you are experimenting this, you can specify the CSS selector for the main content in :guilabel:`Settings > Addons > Advanced`,
32+
If you are experiencing this, you can specify the CSS selector for the main content in :guilabel:`Settings > Addons > Advanced`,
2633
or you can `open an issue in the addons repository <https://github.com/readthedocs/addons>`_ so we improve our heuristic.
34+
35+
Link previews won't be generated if JavaScript is not enabled in your web browser or if all cookies are blocked.

docs/user/traffic-analytics.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ and then click on :guilabel:`Traffic analytics`.
2323
Enabling traffic analytics
2424
--------------------------
2525

26-
#. Go to the new :term:`dashboard`:
26+
#. Go to the new :term:`dashboard`.
2727
#. Click on a project name.
2828
#. Go to :guilabel:`Settings`, then in the left bar, go to :guilabel:`Addons`.
2929
#. Go to :guilabel:`Analytics` and check :guilabel:`Analytics enabled`.

0 commit comments

Comments
 (0)