Clarify how to use :ref: vs :doc: in our templates

openedx · Jan 18, 2024 · 470069c · 470069c
1 parent 5d2b64f
commit 470069c
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/source/documentors/references/doc_templates.rst b/source/documentors/references/doc_templates.rst
@@ -139,7 +139,11 @@ Copy this codeblock to start a new how-to topic.
 
    .. seealso::
 
-     :ref:`title to link to`
+     # To cross-reference a label use :ref:
+     :ref:`reference to link to`
+
+     # To point to another document in the docs.openedx.org filetree, use :doc:
+     :doc:`/relative/path/to_the_document`
 
 
 Add an Ordered List