Add note about tags/commit hashes for RLIs (#2704)

* Add note about tags/commit hashes for RLIs * fix typo Co-authored-by: Starlight220 <[email protected]> --------- Co-authored-by: Starlight220 <[email protected]>
wpilibsuite · Aug 18, 2024 · 66695b7 · 66695b7
1 parent 3e01ed2
commit 66695b7
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/source/docs/contributing/frc-docs/style-guide.rst b/source/docs/contributing/frc-docs/style-guide.rst
@@ -110,6 +110,8 @@ When possible, instead of using code blocks, an RLI should be used.  This pulls
 
 Make sure to link to the raw version of the file on GitHub. There is a handy ``Raw`` button in the top right corner of the page.
 
+.. note:: RLIs should use a tag instead of main to ensure the documentation isn't broken the next time there is a change to the RLIed code. If a tag hasn't been created, use the full (40 character) commit hash.
+
 ## Tabs
 To create code tabs in an article, you can use the ``.. tab-set-code::`` directive.  You can use ``code-block`` and ``rli`` directives inside. The format is: