From 8f60a14ffd3d74e3402e78c88501b920f510c69b Mon Sep 17 00:00:00 2001
From: Nick Krabbenhoeft <nickkrabbenhoeft@nypl.org>
Date: Thu, 20 Jun 2024 10:32:40 -0700
Subject: [PATCH] added instructions for callouts

---
 _config.yml | 28 ++++++++++++++++++----------
 1 file changed, 18 insertions(+), 10 deletions(-)

diff --git a/_config.yml b/_config.yml
index fc3135b..1c2c02e 100644
--- a/_config.yml
+++ b/_config.yml
@@ -19,23 +19,31 @@ ga_tracking_anonymize_ip: true
 
 callouts_level: quiet # or loud
 callouts:
-  highlight:
-    color: blue
-  important:
-    title: Important
+# use for documentation still not fully complete, but partially launched
+  construction:
+    title: Under Construction
     color: yellow
+# use after launching new documentation for external staff, remove after some period time
   new:
     title: New
     color: green
+# use for legacy instruction that will eventually be removed, remove when documentation is removed
+  deprecated:
+    title: Deprecated
+    color: red
+# use to callout requirements before starting process
+  important:
+    title: Important
+    color: yellow
+# use for context to instructions
   note:
     title: Note
     color: purple
+# use for situations where no further work should be completed until situation is resolved
   warning:
     title: Warning
     color: red
-  construction:
-    title: Under Construction
-    color: yellow
-  deprecated:
-    title: Deprecated
-    color: red
\ No newline at end of file
+# use for final instruction or failure remediation
+  highlight:
+    color: blue
+