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
medusajs · Oct 5, 2023 · 0350eeb · 0350eeb
1 parent b3f75d8
commit 0350eeb
Show file tree

Hide file tree

Showing 110 changed files with 7,182 additions and 930 deletions.
diff --git a/.github/workflows/docs-freshness-check.yml b/.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
diff --git a/.github/workflows/docs-new-announcement.yml b/.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

diff --git a/.github/workflows/docs-remove-announcement.yml b/.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

diff --git a/.github/workflows/docs-test.yml b/.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:

diff --git a/.github/workflows/generate-api-reference.yml b/.github/workflows/generate-api-reference.yml
diff --git a/.github/workflows/generate-entity-reference.yml b/.github/workflows/generate-entity-reference.yml
diff --git a/.github/workflows/generate-js-reference.yml b/.github/workflows/generate-js-reference.yml
diff --git a/.github/workflows/generate-reference.yml b/.github/workflows/generate-reference.yml