From 4b49ddabe5f9021b81430ec15a6d4939de9b3b9d Mon Sep 17 00:00:00 2001
From: ClementTsang <cjhtsang@uwaterloo.ca>
Date: Sun, 17 Oct 2021 21:54:06 -0400
Subject: [PATCH] ci: add some documentation in the workflow files

---
 .github/workflows/audit.yml        | 2 ++
 .github/workflows/post-release.yml | 2 +-
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/audit.yml b/.github/workflows/audit.yml
index 1a017bfbb..6189d737d 100644
--- a/.github/workflows/audit.yml
+++ b/.github/workflows/audit.yml
@@ -1,3 +1,5 @@
+# A routine check to see if there are any Rust-specific security vulnerabilities in the repo we should be aware of.
+
 name: audit
 on:
   workflow_dispatch:
diff --git a/.github/workflows/post-release.yml b/.github/workflows/post-release.yml
index 1cf2b9072..5eed7cc45 100644
--- a/.github/workflows/post-release.yml
+++ b/.github/workflows/post-release.yml
@@ -1,4 +1,4 @@
-# Actions to run after releasing a version.
+# Actions to run after releasing a version, like generating documentation via mkdocs or notifying packaging repos.
 name: post-release
 
 on: