add comment

FuelLabs · Jan 29, 2025 · 94df66d · 94df66d
1 parent a83cca8
commit 94df66d
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -119,6 +119,9 @@ jobs:
         if: startsWith(env.LAST_COMMIT_MSG, 'ci(release):') && env.RELEASE_VERSION_HIGHER_THAN_LATEST == 'true'
         run: echo DEPLOY_STABLE_DOCS_API=true >> $GITHUB_ENV
 
+      # nightly docs API gets updated on every merge to master
+      # and is configured in the vercel dashboard
+      # stable docs API gets updated only when a new release is published
       - name: Update Docs API (stable)
         if: github.ref_name == 'master' && env.DEPLOY_STABLE_DOCS_API == 'true'
         env: