ci: add comments to workflows

.github/workflows/check-frontend.yml

@@ -1,3 +1,7 @@
+# This workflow runs the frontend code quality checks.
+#
+# It may be triggered via dispatch, or by another workflow.
+
 name: 'Check: frontend'
 
 on:

.github/workflows/check-pytest.yml

@@ -1,3 +1,7 @@
+# This workflow runs pytest on the codebase in a matrix of platforms.
+#
+# It may be triggered via dispatch, or by another workflow.
+
 name: 'Check: pytest'
 
 on:

.github/workflows/check-python.yml

@@ -1,3 +1,9 @@
+# This workflow runs the python code quality checks.
+#
+# It may be triggered via dispatch, or by another workflow.
+#
+# TODO: Add mypy or pyright to the checks.
+
 name: 'Check: python'
 
 on:

.github/workflows/on-change-check-frontend.yml

@@ -1,3 +1,8 @@
+# This workflow runs of `check-frontend.yml` on push or pull request.
+#
+# The actual checks are in a separate workflow to support simpler workflow
+# composition without awkward or complicated conditionals.
+
 name: 'On change: run check-frontend'
 
 on:

.github/workflows/on-change-check-python.yml

@@ -1,3 +1,8 @@
+# This workflow runs of `check-python.yml` on push or pull request.
+#
+# The actual checks are in a separate workflow to support simpler workflow
+# composition without awkward or complicated conditionals.
+
 name: 'On change: run check-python'
 
 on:

.github/workflows/on-change-pytest.yml

@@ -1,3 +1,8 @@
+# This workflow runs of `check-pytest.yml` on push or pull request.
+#
+# The actual checks are in a separate workflow to support simpler workflow
+# composition without awkward or complicated conditionals.
+
 name: 'On change: run pytest'
 
 on: