Suggested additions from contributor. (#4990)

* Suggested additions from contributor. * I think this is the formatting it wants. * Update source/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.rst Co-authored-by: Christophe Bedard <[email protected]> Signed-off-by: Katherine Scott <[email protected]> --------- Signed-off-by: Katherine Scott <[email protected]> Co-authored-by: Christophe Bedard <[email protected]> (cherry picked from commit b0a330a)
ros2 · Feb 4, 2025 · 918cc52 · 918cc52
1 parent 0a10afc
commit 918cc52
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/source/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.rst b/source/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.rst
@@ -278,6 +278,10 @@ Writing pages
 
 The ROS 2 documentation website uses the ``reStructuredText`` format, which is the default plaintext markup language used by Sphinx.
 This section is a brief introduction to ``reStructuredText`` concepts, syntax, and best practices.
+When formatting your ``reStructuredText`` file **please make sure to write only one sentence per line as it makes reviewing and modifying your file much easier.**
+Also, be mindful of the use of white space in your file!
+The ROS 2 documentation linter will not accept pull requests with trailing white space.
+We recommend that you enable automatic white space highlighting and or cleanup if your editor supports it.
 
 You can refer to `reStructuredText User Documentation <https://docutils.sourceforge.io/rst.html>`_ for a detailed technical specification.
 
@@ -383,6 +387,13 @@ Images can be inserted using the ``.. image::`` directive.
 
    .. image:: images/turtlesim_follow1.png
 
+Charts, Graphs, and Diagrams
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The ROS 2 Documentation now supports charts, graphs, and diagrams written using `Mermaid Charts. <https://mermaid.js.org/intro/>`__
+We prefer that charts, graphs, and diagrams use Mermaid instead of static image files as it allows us to programmatically update and edit these resources as the project evolves.
+Full documentation of the `Mermaid graph language syntax can be found on their website. <https://mermaid.js.org/intro/syntax-reference.html>`__
+
 References and Links
 ^^^^^^^^^^^^^^^^^^^^