Update docs README and deployment action

PufferFinance · May 30, 2024 · 1ce7302 · 1ce7302
1 parent e033729
commit 1ce7302
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -1,12 +1,12 @@
+# Use this action when needed to manually deploying the docs. Deployment
+# of docs is a part of the publish.yml workflow because the release
+# trigger doesn't work for automated releases. See
+# https://github.com/orgs/community/discussions/25281.
+
 name: deploy-docs
 
 on:
   workflow_dispatch:
-
-  # Deployment of docs is a part of the publish.yml workflow because the
-  # release trigger doesn't work for automated releases. See
-  # https://github.com/orgs/community/discussions/25281.
-  # ---
   # release:
   #   types: [published, released]
 

diff --git a/docs/README.md b/docs/README.md
@@ -30,4 +30,4 @@ This command generates static content into the `build` directory and can be serv
 
 ### Deployment
 
-The deployment of the docs is automated with each release. See the [deploy-docs.yml](../.github/workflows/deploy-docs.yml) GitHub action.
+The deployment of the docs is automated with each release. See the [publish.yml](../.github/workflows/publish.yml) GitHub action.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -30,4 +30,4 @@ This command generates static content into the `build` directory and can be serv

		### Deployment

		The deployment of the docs is automated with each release. See the [deploy-docs.yml](../.github/workflows/deploy-docs.yml) GitHub action.
		The deployment of the docs is automated with each release. See the [publish.yml](../.github/workflows/publish.yml) GitHub action.