Feature Request/Idea: Provide tips on writing .rst (reStructuredText) files

[pdurbin]

Overview of the Feature Request

Provide tips on writing .rst files in the context of our Sphinx-based guides. I find reStructuredText (.rst) to be quirky and intuitive, especially compared to Markdown.

What kind of user is the feature intended for?

Documentation writers. Docs are required for most pull requests.

What inspired the request?

I simply could not remember or quickly find how to add a custom title to a :doc: link.

Finally, I found https://docs.readthedocs.io/en/stable/guides/cross-referencing-with-sphinx.html#the-doc-role which explains that to do this:

:doc:`Custom title </guides/intersphinx>`

We can add tips like this to our existing "Writing Documentation" page at https://guides.dataverse.org/en/latest/developers/documentation.html

Topics to cover:

• making links
  • linking to other pages
  • creating and linking to custom anchors
  • linking to external websites
• ...
• ...

What existing behavior do you want changed?

None.

Any brand new behavior do you want to add to Dataverse?

None.

Any related open or closed issues to this feature request?

None.