docs: create typedoc theme and plugins for references (#5297)

* update typedoc and its plugins

* refactor existing typedoc configurations

* added new typedoc plugin and themes

* added more customization options

* added more customization options

* refactored doc-utils to a workspace

* fix tsconfig

* update README files

* remove comments

* revert type changes

* remove dependencies no longer needed

* removed modules action

.github/workflows/docs-freshness-check.yml

@@ -32,5 +32,10 @@ jobs:
         with:
           extension: docs-freshness-check
 
+      - name: Install Workspace dependencies
+        run: yarn install
+        working-directory: docs-utils
+
       - name: Perform Freshness Check
         run: yarn check:freshness
+        working-directory: docs-utils/packages/scripts

.github/workflows/docs-new-announcement.yml

@@ -30,11 +30,13 @@ jobs:
         with:
           extension: docs-release
 
-      - name: Build Packages
-        run: yarn build
+      - name: Install Workspace dependencies
+        run: yarn install
+        working-directory: docs-utils
 
       - name: Generate Announcement Bar
         run: yarn generate:announcement
+        working-directory: docs-utils/packages/scripts
 
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v4

.github/workflows/docs-remove-announcement.yml

@@ -31,8 +31,13 @@ jobs:
         with:
           extension: docs-remove-announcement
 
+      - name: Install Workspace dependencies
+        run: yarn install
+        working-directory: docs-utils
+
       - name: Remove Announcement Bar
         run: yarn generate:announcement --expire
+        working-directory: docs-utils/packages/scripts
 
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v4

.github/workflows/docs-test.yml

@@ -32,6 +32,7 @@ jobs:
       - name: Install Workspace dependencies
         working-directory: www
         run: yarn install
+
       - name: Build Docusaurus website
         working-directory: www
         env:

.github/workflows/generate-api-reference.yml

@@ -1,48 +0,0 @@
-name: Generate API Reference
-on:
-  workflow_dispatch:
-  release:
-    types: [published]
-
-jobs:
-  api:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Cancel Previous Runs
-        uses: styfle/cancel-workflow-action@0.11.0
-        with:
-          access_token: ${{ github.token }}
-
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          token: ${{ secrets.REFERENCE_PAT }}
-          fetch-depth: 0
-
-      - name: Setup Node.js environment
-        uses: actions/setup-node@v3
-        with:
-          node-version: "16.20.2"
-          cache: "yarn"
-
-      - name: Install dependencies
-        uses: ./.github/actions/cache-deps
-        with:
-          extension: reference
-
-      - name: Build Packages
-        run: yarn build
-
-      - name: Generate API Reference
-        run: yarn openapi:generate
-
-      - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v4
-        with:
-          commit-message: "chore(docs): Generated API Reference"
-          base: "develop"
-          title: "chore(docs): Updated API Reference"
-          labels: "type: chore"
-          add-paths: www/apps/api-reference/specs
-          branch: "chore/generate-api-ref"
-          branch-suffix: "timestamp"

.github/workflows/generate-entity-reference.yml

@@ -1,47 +0,0 @@
-name: Generate Entity Reference
-on:
-  workflow_dispatch:
-  release:
-    types: [published]
-
-jobs:
-  services:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Cancel Previous Runs
-        uses: styfle/cancel-workflow-action@0.11.0
-        with:
-          access_token: ${{ github.token }}
-
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-
-      - name: Setup Node.js environment
-        uses: actions/setup-node@v3
-        with:
-          node-version: "16.20.2"
-          cache: "yarn"
-
-      - name: Install dependencies
-        uses: ./.github/actions/cache-deps
-        with:
-          extension: reference
-
-      - name: Build Packages
-        run: yarn build
-
-      - name: Generate Entities Reference
-        run: yarn generate:entities
-
-      - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v4
-        with:
-          commit-message: "chore(docs): Generated Entities Reference (automated)"
-          base: "develop"
-          title: "chore(docs): Generated Entities Reference (automated)"
-          labels: "type: chore"
-          add-paths: www/apps/docs/content/references/entities/**
-          branch: "chore/generate-entities"
-          branch-suffix: "timestamp"

.github/workflows/generate-js-reference.yml

@@ -1,47 +0,0 @@
-name: Generate JS Client Reference
-on:
-  workflow_dispatch:
-  release:
-    types: [published]
-
-jobs:
-  services:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Cancel Previous Runs
-        uses: styfle/cancel-workflow-action@0.11.0
-        with:
-          access_token: ${{ github.token }}
-
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-
-      - name: Setup Node.js environment
-        uses: actions/setup-node@v3
-        with:
-          node-version: "16.20.2"
-          cache: "yarn"
-
-      - name: Install dependencies
-        uses: ./.github/actions/cache-deps
-        with:
-          extension: reference
-
-      - name: Build Packages
-        run: yarn build
-
-      - name: Generate Services Reference
-        run: yarn generate:js-client
-
-      - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v4
-        with:
-          commit-message: "chore(docs): Generated JS Client Reference (automated)"
-          base: "develop"
-          title: "chore(docs): Generated JS Client Reference"
-          labels: "type: chore"
-          add-paths: www/apps/docs/content/references/js-client/**
-          branch: "chore/generate-js-client"
-          branch-suffix: "timestamp"

.github/workflows/generate-reference.yml

@@ -1,47 +0,0 @@
-name: Generate Services Reference
-on:
-  workflow_dispatch:
-  release:
-    types: [published]
-
-jobs:
-  services:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Cancel Previous Runs
-        uses: styfle/cancel-workflow-action@0.11.0
-        with:
-          access_token: ${{ github.token }}
-
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-
-      - name: Setup Node.js environment
-        uses: actions/setup-node@v3
-        with:
-          node-version: "16.20.2"
-          cache: "yarn"
-
-      - name: Install dependencies
-        uses: ./.github/actions/cache-deps
-        with:
-          extension: reference
-
-      - name: Build Packages
-        run: yarn build
-
-      - name: Generate Services Reference
-        run: yarn generate:services
-
-      - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v4
-        with:
-          commit-message: "chore(docs): Generated Services Reference (automated)"
-          base: "develop"
-          title: "chore(docs): Generated Services Reference (automated)"
-          labels: "type: chore"
-          add-paths: www/apps/docs/content/references/services/**
-          branch: "chore/generate-services"
-          branch-suffix: "timestamp"

.github/workflows/generate-references.yml

@@ -0,0 +1,183 @@
+name: Generate Documentation Reference
+on:
+  workflow_dispatch:
+  release:
+    types: [published]
+
+jobs:
+  services:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Cancel Previous Runs
+        uses: styfle/cancel-workflow-action@0.11.0
+        with:
+          access_token: ${{ github.token }}
+
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v3
+        with:
+          node-version: "16.20.2"
+          cache: "yarn"
+
+      - name: Install dependencies
+        uses: ./.github/actions/cache-deps
+        with:
+          extension: reference
+
+      - name: Build Packages
+        run: yarn build
+
+      - name: Install Workspace dependencies
+        run: yarn install
+        working-directory: docs-utils
+
+      - name: Generate Services Reference
+        run: yarn generate:reference services
+        working-directory: docs-utils/packages/scripts
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: "chore(docs): Generated Services Reference (automated)"
+          base: "develop"
+          title: "chore(docs): Generated Services Reference (automated)"
+          labels: "type: chore"
+          add-paths: www/apps/docs/content/references/services/**
+          branch: "chore/generate-services"
+          branch-suffix: "timestamp"
+  api:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Cancel Previous Runs
+        uses: styfle/cancel-workflow-action@0.11.0
+        with:
+          access_token: ${{ github.token }}
+
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.REFERENCE_PAT }}
+          fetch-depth: 0
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v3
+        with:
+          node-version: "16.20.2"
+          cache: "yarn"
+
+      - name: Install dependencies
+        uses: ./.github/actions/cache-deps
+        with:
+          extension: reference
+
+      - name: Build Packages
+        run: yarn build
+
+      - name: Generate API Reference
+        run: yarn openapi:generate
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: "chore(docs): Generated API Reference"
+          base: "develop"
+          title: "chore(docs): Updated API Reference"
+          labels: "type: chore"
+          add-paths: www/apps/api-reference/specs
+          branch: "chore/generate-api-ref"
+          branch-suffix: "timestamp"
+  entities:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Cancel Previous Runs
+        uses: styfle/cancel-workflow-action@0.11.0
+        with:
+          access_token: ${{ github.token }}
+
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v3
+        with:
+          node-version: "16.20.2"
+          cache: "yarn"
+
+      - name: Install dependencies
+        uses: ./.github/actions/cache-deps
+        with:
+          extension: reference
+
+      - name: Build Packages
+        run: yarn build
+
+      - name: Install Workspace dependencies
+        run: yarn install
+        working-directory: docs-utils
+
+      - name: Generate Entities Reference
+        run: yarn generate:references entities
+        working-directory: docs-utils/packages/scripts
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: "chore(docs): Generated Entities Reference (automated)"
+          base: "develop"
+          title: "chore(docs): Generated Entities Reference (automated)"
+          labels: "type: chore"
+          add-paths: www/apps/docs/content/references/entities/**
+          branch: "chore/generate-entities"
+          branch-suffix: "timestamp"
+  js-client:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Cancel Previous Runs
+        uses: styfle/cancel-workflow-action@0.11.0
+        with:
+          access_token: ${{ github.token }}
+
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v3
+        with:
+          node-version: "16.20.2"
+          cache: "yarn"
+
+      - name: Install dependencies
+        uses: ./.github/actions/cache-deps
+        with:
+          extension: reference
+
+      - name: Build Packages
+        run: yarn build
+
+      - name: Install Workspace dependencies
+        run: yarn install
+        working-directory: docs-utils
+
+      - name: Generate Services Reference
+        run: yarn generate:references js-client
+        working-directory: docs-utils/packages/scripts
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: "chore(docs): Generated JS Client Reference (automated)"
+          base: "develop"
+          title: "chore(docs): Generated JS Client Reference"
+          labels: "type: chore"
+          add-paths: www/apps/docs/content/references/js-client/**
+          branch: "chore/generate-js-client"
+          branch-suffix: "timestamp"