Added comments to JavaDoc publication yml file

.github/workflows/publish-javadoc.yml

@@ -1,6 +1,12 @@
 name: Deploy Javadoc
 
+#Note: The Javadoc-publisher action only commits to javadoc branch and triggers the GitHub pages update action if there
+# are changes in the JavaDoc, i.e. it ignores the Readme.md that is used as main landing page of the GitHub pages!
+# And these need to be merged into the javadoc branch.
+
 on:
+  #release: # to trigger this only at new releases, comment this in and the next three lines out
+    #types: [created, published, released]
   push:
     branches:
       - main
@@ -12,7 +18,7 @@ jobs:
       - name: Deploy JavaDoc 🚀
         uses: MathieuSoysal/Javadoc-publisher.yml@v2.4.0
         with:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
           javadoc-branch: javadoc
           java-version: 17
           target-folder: javadoc