From f3177bc9b8058d859fbf15bd8ced578b7fe39eb1 Mon Sep 17 00:00:00 2001
From: Steven Luscher <steveluscher@users.noreply.github.com>
Date: Sun, 24 Nov 2024 23:43:49 -0800
Subject: [PATCH] Add comments

---
 .github/workflows/actions/compile-gh-pages/action.yml | 5 ++++-
 .github/workflows/preview-gh-pages.yml                | 3 ++-
 .github/workflows/publish-gh-pages.yml                | 3 ++-
 3 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/.github/workflows/actions/compile-gh-pages/action.yml b/.github/workflows/actions/compile-gh-pages/action.yml
index 56331cfa347..4e68ebcaa45 100644
--- a/.github/workflows/actions/compile-gh-pages/action.yml
+++ b/.github/workflows/actions/compile-gh-pages/action.yml
@@ -4,6 +4,8 @@ description: Compiles content for GitHub Pages and uploads it to the artifact ca
 inputs:
   pr-number:
     type: number
+  # Typically used when it's important to know the base URL for the GitHub Pages site,
+  # for instance when a web app's router needs to know its base URL.
   repository:
     default: 'solana-web3.js'
     type: string
@@ -24,7 +26,8 @@ runs:
         mv ./examples/react-app/dist/ .ghpages-deploy/example/
         mv ./docs/* .ghpages-deploy/
 
-    - uses: actions/upload-artifact@v4
+    - name: Upload Deploy Directory to Artifact Cache
+      uses: actions/upload-artifact@v4
       with:
         include-hidden-files: true
         name: ghpages-deploy-artifacts
diff --git a/.github/workflows/preview-gh-pages.yml b/.github/workflows/preview-gh-pages.yml
index c3288dd0180..1751ed66108 100644
--- a/.github/workflows/preview-gh-pages.yml
+++ b/.github/workflows/preview-gh-pages.yml
@@ -58,7 +58,8 @@ jobs:
       - name: Install Dependencies
         uses: ./.github/workflows/actions/install-dependencies
 
-      - uses: actions/download-artifact@v4
+      - name: Download Deploy Directory from Artifact Cache
+        uses: actions/download-artifact@v4
         with:
           path: .ghpages-deploy
           pattern: ghpages-deploy-artifacts*
diff --git a/.github/workflows/publish-gh-pages.yml b/.github/workflows/publish-gh-pages.yml
index 0be21b6f282..1993584ced0 100644
--- a/.github/workflows/publish-gh-pages.yml
+++ b/.github/workflows/publish-gh-pages.yml
@@ -59,7 +59,8 @@ jobs:
       - name: Install Dependencies
         uses: ./.github/workflows/actions/install-dependencies
 
-      - uses: actions/download-artifact@v4
+      - name: Download Deploy Directory from Artifact Cache
+        uses: actions/download-artifact@v4
         with:
           path: .ghpages-deploy
           pattern: ghpages-deploy-artifacts*