openedx / docs.openedx.org

[BETA] A new home for learning about Open edX
https://docs.openedx.org
Other
7 stars 57 forks source link

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

Closed sarina closed 8 months ago

sarina commented 8 months ago

In https://docs.openedx.org/en/latest/documentors/references/doc_templates.html#create-a-how-to the seealso directive says to use :ref:, however, :doc: is the way to reference a whole document. Added an example and comments to clarify when to use which.