add comment describing the link checker workflow

Signed-off-by: MarkAckert <[email protected]>
zowe · Dec 10, 2024 · c4e7233 · c4e7233
1 parent 00647e4
commit c4e7233
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/.github/workflows/link-check.yml b/.github/workflows/link-check.yml
@@ -1,3 +1,6 @@
+# This link checker focuses on covering end-user facing links, not developer documentation.
+#   This means we cover the smp/e, pswi, and zwe content.
+# The lychee toml files are set to ignore links which popped up in comments or variables.
 permissions: read-all
 
 name: Link Check CI