Add autodoc action to transfer input/output documentation to README

.github/workflows/autodoc-action.yml

@@ -0,0 +1,35 @@
+name: Update README.md with the latest actions.yml
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  update-doc:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # otherwise, you will failed to push refs to dest repo
+
+      - name: Run auto-doc
+        uses: tj-actions/auto-doc@v3
+
+      - name: Verify Changed files
+        uses: tj-actions/[email protected]
+        id: verify-changed-files
+        with:
+          files: |
+            README.md
+
+      - name: Create Pull Request
+        if: steps.verify-changed-files.outputs.files_changed == 'true'
+        uses: peter-evans/create-pull-request@v3
+        with:
+          base: "main"
+          title: "auto-doc: Updated README.md"
+          branch: "chore/auto-doc-update-readme"
+          commit-message: "auto-doc: Updated README.md"
+          body: "auto-doc: Updated README.md"