chore: updated docs

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -70,6 +70,15 @@ body:
     attributes:
       label: Relevant log output
       description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      placeholder: |
+        ### This can be done by:
+        - #### Re-running the workflow with debug logging enabled.
+        ![Screen Shot 2022-10-26 at 2 30 41 PM](https://user-images.githubusercontent.com/17484350/198131404-2ff30c05-bf5f-4670-94f7-ab28bbfad4f5.png)
+
+        ### AND
+
+        - #### Downloading the log archive
+        ![Screen Shot 2022-10-26 at 2 33 04 PM](https://user-images.githubusercontent.com/17484350/198131757-85715722-6a8d-4125-85af-76954420f28b.png)
       render: shell
   - type: textarea
     attributes:

.github/workflows/update-readme.yml

@@ -13,6 +13,11 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Run auto-doc
+        uses: tj-actions/auto-doc@v1.4.1
+        with:
+          col_max_words: 12
+
       - name: Run test
         uses: tj-actions/remark@v3