fix(docs): organize exports into namespaces for better typedocs (#1269)

Author: subhankarmaiti

.github/workflows/publish-docs.yml

@@ -0,0 +1,83 @@
+name: PUBLISH DOCS
+on:
+    workflow_dispatch:
+    workflow_call:
+    # or set up your own custom triggers
+permissions:
+    contents: write # allows the 'Commit' step without tokens
+
+jobs:
+    get_history: # create an artifact from the existing documentation builds
+        runs-on: ubuntu-latest
+        steps:
+            - name: get the gh-pages repo
+              uses: actions/checkout@v4
+              with:
+                  ref: gh-pages
+
+            - name: tar the existing docs
+              run: |
+                  mkdir -p ./docs
+                  tar -cvf documentation.tar ./docs
+
+            - name: create a document artifact
+              uses: actions/upload-artifact@v4
+              with:
+                  name: documentation
+                  path: documentation.tar
+
+    build: # builds the distribution and then the documentation
+        needs: get_history
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout src
+              uses: actions/checkout@v4
+
+            - run: mkdir -p ./docs
+            - name: Download the existing documents artifact
+              uses: actions/download-artifact@v4
+              with:
+                  name: documentation
+            - run: tar -xf documentation.tar -C ./docs
+
+            - name: Setup
+              uses: ./.github/actions/setup
+
+            - name: Build documents
+              run: yarn docs #set up 'docs' build script in your package.json
+              
+            - name: Run cleanup and manage document versions
+              run: node scripts/manage-doc-versions.js
+
+            - name: tar the new docs
+              run: tar -cvf newdocumentation.tar ./docs
+
+            - name: create a new document artifact
+              uses: actions/upload-artifact@v4
+              with:
+                  name: newdocumentation
+                  path: newdocumentation.tar
+
+    commit: # commit the old and new merged documents to gh-pages/docs
+        needs: build
+        runs-on: ubuntu-latest
+        steps:
+            - name: checkout the gh-pages repo
+              uses: actions/checkout@v4
+              with:
+                  ref: gh-pages
+
+            - run: mkdir -p ./docs
+            - name: Download the new documents artifact
+              uses: actions/download-artifact@v4
+              with:
+                  name: newdocumentation
+            - run: tar -xf newdocumentation.tar -C ./docs
+
+            - name: commit
+              run: |
+                  git config --global user.email "[email protected]"
+                  git config --global user.name "Continuous Integration"
+                  git add .
+                  git commit -m "CI updated the documentation"
+                  git push

.github/workflows/release.yml

@@ -9,6 +9,7 @@ on:
 permissions:
   contents: write
   id-token: write # For publishing to npm using --provenance
+  pages: write # For publishing documentation
 
 ### TODO: Replace instances of './.github/workflows/' w/ `auth0/dx-sdk-actions/workflows/` and append `@latest` after the common `dx-sdk-actions` repo is made public.
 ### TODO: Also remove `get-prerelease`, `get-release-notes`, `get-version`, `npm-publish`, `release-create`, and `tag-exists` actions from this repo's .github/actions folder once the repo is public.
@@ -20,3 +21,12 @@ jobs:
     secrets:
       npm-token: ${{ secrets.NPM_TOKEN }}
       github-token: ${{ secrets.GITHUB_TOKEN }}
+
+  publish-docs:
+    needs: release
+    if: success()
+    uses: ./.github/workflows/publish-docs.yml
+    permissions:
+      contents: write
+      pages: write
+      id-token: write

.gitignore

@@ -94,4 +94,5 @@ android/generated
 # Other
 dist/
 out/
-coverage/
+coverage/
+docs/

.shiprc

@@ -2,6 +2,5 @@
     "files": {
         "src/core/utils/telemetry.ts": [],
         ".version": []
-    },
-    "postbump": "node scripts/jsdocs.js"
+    }
 }