Updating the documentation style guide

docs/contributing/docs_style_guide.md

@@ -0,0 +1,21 @@
+# Documentation Style Guide
+
+## Do's
+
+- Submit documentation formatted in [Markdown](https://en.wikipedia.org/wiki/Markdown) format.
+  -- Please add Markdown headings to the content sections.
+- Use a GitHub Pull Request to submit documentation.
+- Use the "bold/emphasis" style in Markdown for UI elements that users will interact with. For example, a button label for a button that must be pressed should be made bold in Markdown.
+- Use the "italics" style in Markdown for UI elements that have a label or title if you need to reference them in the documentation. For example, a title of a screen or page that will visit should be made italic in Markdown.
+- Use `-` instead of `*` for bulleted lists.
+- Upload images to the 'assets' folder and reference them from there. 
+   -- For file name, use underscores between words and prefix all file names with the page name, e.g. context_display_hints.jpg for the image showing how to set display hints in the context menu.
+- Use `!!! note` at the start of a paragraph to have it rendered as a note like this:
+
+!!! note I am a helpful tip!
+
+## Don'ts
+
+- Do not leave any "trailing spaces" at the end of lines of content.
+- Do not use "curly" quotes and apostrophes, use only "straight" quotes and apostrophes.
+- Do not upload images that are excessively large in file size (remember, these docs are part of the software!)

mkdocs.yml

@@ -66,7 +66,6 @@ pages:
     - 'Flysystem': 'technical-documentation/flysystem.md'
     - 'JWT Authentication': 'technical-documentation/jwt.md'
     - 'Versioning Policy': 'technical-documentation/versioning.md'
-    - 'Documentation Style Guide': 'technical-documentation/docs_style_guide.md'
     - 'How to Build Documentation': 'technical-documentation/docs-build.md'
     - 'Testing Notes': 'technical-documentation/testing-notes.md'
     - 'Adding back ?_format=jsonld': 'technical-documentation/adding_format_jsonld.md'
@@ -77,4 +76,5 @@ pages:
       - 'Islandora 7': 'technical-documentation/migrate-7x.md'
   - Contributing:
       - 'How to contribute': 'contributing/CONTRIBUTING.md'
+      - 'Documentation Style Guide': 'contributing/docs_style_guide.md'
       - 'Committers': 'contributing/committers.md'