Updates for allhands (#3)

.github/workflows/call-super-linter.yaml

@@ -1,4 +1,5 @@
 ---
+# template source: https://github.com/bretfisher/super-linter-workflow/blob/main/templates/call-super-linter.yaml
 name: Lint Code Base
 
 on:
@@ -12,21 +13,25 @@ jobs:
   call-super-linter:
 
     name: Call Super-Linter
-
-    # use Reusable Workflows to call my linter config remotely
-    # https://docs.github.com/en/actions/learn-github-actions/reusing-workflows
     
     permissions:
       contents: read # clone the repo to lint
       statuses: write #read/write to repo custom statuses
 
-    #FIXME: customize uri to point to your forked linter repository
-    uses: bretfisher/super-linter-workflow/.github/workflows/super-linter.yaml@main
+    ### use Reusable Workflows to call my workflow remotely
+    ### https://docs.github.com/en/actions/learn-github-actions/reusing-workflows
+    ### you can also call workflows from inside the same repo via file path
+
+    #FIXME: customize uri to point to your own linter repository
+    uses: bretfisher/super-linter-workflow/.github/workflows/reusable-super-linter.yaml@main
     
-    # Optional settings examples
+    ### Optional settings examples
     
     # with:
-    
+      ### For a DevOps-focused repository. Prevents some code-language linters from running
+      ### defaults to false
       # devops-only: false
       
+      ### A regex to exclude files from linting
+      ### defaults to empty
       # filter-regex-exclude: html/.*