Skip to content

Commit

Permalink
manual: develop: add the beginnings of a style guide
Browse files Browse the repository at this point in the history
  • Loading branch information
attie authored and whitequark committed Oct 21, 2023
1 parent 5fb1638 commit 3f802df
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/manual/src/develop/docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,15 @@ At the moment, some of the URLs fail despite being valid, so this command is not
.. _Sphinx: https://www.sphinx-doc.org/en/master/index.html
.. _PDM: https://pdm.fming.dev/latest/
.. _install PDM: https://pdm.fming.dev/latest/#installation


Style guide
-----------

When writing documentation, please try to follow our style:

* Only capitalise the first word of headings
* Insert two blank lines before headings
* Use ``.. note::`` and ``.. warning::`` sparingly, but where important details may otherwise be missed
* Use an em-dash (---), which can be written as ``---`` in restructured text
* Link to our official `GlasgowEmbedded <https://github.com/GlasgowEmbedded>`_ repositories where appropriate

0 comments on commit 3f802df

Please sign in to comment.