Differences

This shows you the differences between two versions of the page.

--- evergreen-docs:dig_style_guide [2021/10/27 15:49] – [Screenshots] jpringle
+++ evergreen-docs:dig_style_guide [2023/06/01 12:22] (current) – update branch name from master to main gmcharlton
@@ Line 67: / Line 67: @@
 ===== General =====
   * **Avoid changing section titles**. These are used to auto-generate anchor tags which are often used for links. Change with care, and check for links in other docs.
-  * Always **review changes** before committing to master (and check the updated web page the next day to make sure it worked right).
+  * Always **review changes** before committing to main (and check the updated web page the next day to make sure it worked right).
-  * Always use **spell-check** on new content (including when porting old docs into master).
+  * Always use **spell-check** on new content (including when porting old docs into main).
   * AsciiDoc code lines should be 80 characters long or shorter. (Occasionally, exceptions are necessary for correct syntax.)
   * Screenshots should be smaller than 1050 pixels wide (when possible).
+  * Rather than recreating documentation text in multiple adoc files, instead link directly to the main adoc for the feature.
 ===== Formatting =====
 ==== Headers ====
@@ Line 186: / Line 187: @@
   * **Don't add a border or shadow** to the screenshot image. That can be done globally to all screenshots in the docs via CSS, if we want it.
   * **When replacing a screenshot**, if the intention of the image isn't changing, then create a new image with the same file name as the old image.  However, if you are essentially removing a screenshot and adding a different one (with a different focus or purpose), it is better to use a different file name (and update the reference to it in the docs!), and probably to change the related text in the documentation also.
-  * Image syntax: ''image::folder/filename.png[alt text]''. Starting with version 3.8 screenshots should be put into folders with the same name as the page the images appear on.  For example, if your page is circulation_policies.adoc in the admin folder the image folder would be called circulation_policies and would be in admin -> assets -> images -> circulation_policies.
+  * Image syntax: ''image::ascii_doc_name/imagename.png[alt text]''. Starting with version 3.8 screenshots should be put into folders with the same name as the page the images appear on.  For example, if your page is circulation_policies.adoc in the admin folder the image folder would be called circulation_policies and would be in admin -> assets -> images -> circulation_policies.
   * Alt text: Please remember to include alt text in the image syntax for descriptive and accessibility reasons.
   * Screen shots can be from any installation of Evergreen, as long as it does not contain any personal identifiable information, and is based on stock Evergreen.