Merge pull request #92 from CityOfZion/CU-86a0uwqwy

CU-86a0uwqwy - For neon-dappkit and wcsdk: Folders /dist and /docs sh…

.github/workflows/npm-publish.yml

@@ -38,10 +38,12 @@ jobs:
         run: rush rebuild
       - name: Publish Projects
         run: rush publish --apply --target-branch main --publish --npm-auth-token ${{ secrets.NPM_TOKEN }} --add-commit-details --include-all
+      - name: Merge Docs
+        run: rush docs
       - name: Publish Docs
         uses: actions/upload-pages-artifact@v2
         with:
-          path: './packages/wallet-connect-sdk-core/docs'
+          path: './docs'
       - name: Deploy GitHub Pages
         uses: actions/deploy-pages@v2
       - name: Commit and Push package.json version update

.gitignore

@@ -7,6 +7,7 @@ yarn-error.log*
 # build files
 packages/*/dist/
 packages/*/docs/
+/docs/
 
 # Runtime data
 *.pid

common/autoinstallers/rush-docs/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "rush-docs",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "update-script": "rush update-autoinstaller --name rush-docs"
+  },
+  "dependencies": {
+    "@types/node": "^20.8.2",
+    "typescript": "^4.3.2",
+    "typedoc": "^0.25.1"
+  }
+}

common/changes/@cityofzion/wallet-connect-sdk-core/CU-86a0uwqwy_2023-10-04-18-35.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@cityofzion/wallet-connect-sdk-core",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@cityofzion/wallet-connect-sdk-core"
+}

common/changes/@cityofzion/wallet-connect-sdk-react/CU-86a0uwqwy_2023-10-04-18-35.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@cityofzion/wallet-connect-sdk-react",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@cityofzion/wallet-connect-sdk-react"
+}

common/changes/@cityofzion/wallet-connect-sdk-wallet-core/CU-86a0uwqwy_2023-10-04-18-35.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@cityofzion/wallet-connect-sdk-wallet-core",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@cityofzion/wallet-connect-sdk-wallet-core"
+}

common/changes/@cityofzion/wallet-connect-sdk-wallet-react/CU-86a0uwqwy_2023-10-04-18-35.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@cityofzion/wallet-connect-sdk-wallet-react",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@cityofzion/wallet-connect-sdk-wallet-react"
+}

common/config/rush/command-line.json

@@ -0,0 +1,12 @@
+{
+  "commands": [
+    {
+      "name": "docs",
+      "commandKind": "global",
+      "summary": "Used to generate documentation of each package",
+      "safeForSimultaneousRushProcesses": true,
+      "autoinstallerName": "rush-docs",
+      "shellCommand": "for /d %i in (./packages/*) do (npm run docs --prefix packages/%i/) && typedoc --options typedoc.json"
+    }
+  ]
+}

packages/wallet-connect-sdk-wallet-react/package.json

@@ -27,7 +27,7 @@
   "scripts": {
     "build": "microbundle-crl --no-compress --format modern,cjs",
     "start": "microbundle-crl watch --no-compress --format modern,cjs",
-    "docs": "typedoc",
+    "docs": "typedoc src/index.ts",
     "fmt": "eslint .",
     "publishDocs:develop": "aws s3 sync ./docs s3://marketing-neon-wallet/dev/wksdk/react --acl public-read",
     "publishDocs:prod": "aws s3 sync ./docs s3://marketing-neon-wallet/prod/wksdk/react --acl public-read"

typedoc.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "tsconfig": "tsconfig.json",
+  "entryPoints": [
+    "packages/wallet-connect-sdk-core/",
+    "packages/wallet-connect-sdk-react/",
+    "packages/wallet-connect-sdk-wallet-core/",
+    "packages/wallet-connect-sdk-wallet-react/src/index.tsx"
+  ],
+  "includeVersion": true,
+  "entryPointStrategy": "packages",
+  "out": "docs",
+  "exclude": ["**/dist/**"],
+  "compilerOptions": {
+    "jsx": "react"
+  }
+}