chore: move docs-util to www (#7232)

* reorganize docs apps

* add README

* fix directory

* add condition for old docs

* move docs-util to www

* remove remaining docs-util

* fixes of paths

* fix scripts

* path fixes

* fix github actions

* add build packages script

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

@@ -34,8 +34,8 @@ jobs:
 
       - name: Install Workspace dependencies
         run: yarn install
-        working-directory: docs-util
+        working-directory: www/utils
 
       - name: Perform Freshness Check
         run: yarn check:freshness
-        working-directory: docs-util/packages/scripts
+        working-directory: www/utils/packages/scripts

.github/workflows/docs-test.yml

@@ -37,6 +37,13 @@ jobs:
       - name: Build Doc Apps
         working-directory: www
         run: yarn build
+        env:
+          NEXT_PUBLIC_BASE_URL: "http://localhost:3000"
+          NEXT_PUBLIC_DOCS_URL: "https://medusa-docs.vercel.app"
+          NEXT_PUBLIC_UI_URL: "https://docs-ui.vercel.app"
+          # TODO change once we have actual URLs
+          NEXT_PUBLIC_RESOURCES_URL: "http://example.com"
+          NEXT_PUBLIC_USER_GUIDE_URL: "http://example.com"
         
   vale-book:
     if: ${{ startsWith(github.head_ref, 'docs/') }}
@@ -52,13 +59,13 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Install docs-util Dependencies
+      - name: Install www/utils Dependencies
         run: yarn
-        working-directory: docs-util
+        working-directory: www/utils
 
       - name: Build packages
         run: yarn build
-        working-directory: docs-util
+        working-directory: www/utils
 
       # reviewdog throws an error when the number
       # of file changes in a PR is > 300, so
@@ -67,7 +74,7 @@ jobs:
       # less than 300. This is to avoid a PR hanging in
       # an error state
       - name: Get PR files number
-        working-directory: docs-util/packages/scripts
+        working-directory: www/utils/packages/scripts
         run: 'yarn check:pr-files-count ${{ github.ref_name }}'
         id: pr-files
 
@@ -78,6 +85,7 @@ jobs:
         id: directories
 
       - name: Vale Linter
+        if: ${{ steps.pr-files.outputs.files_lt_threshold == 'true' }}
         uses: errata-ai/vale-action@reviewdog
         with:
           files: ${{ steps.directories.outputs.LIST }}
@@ -103,6 +111,14 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Install www/utils Dependencies
+        run: yarn
+        working-directory: www/utils
+
+      - name: Build packages
+        run: yarn build
+        working-directory: www/utils
+
       # reviewdog throws an error when the number
       # of file changes in a PR is > 300, so
       # we retrieve the number of changed files
@@ -110,7 +126,7 @@ jobs:
       # less than 300. This is to avoid a PR hanging in
       # an error state
       - name: Get PR files number
-        working-directory: docs-util/packages/scripts
+        working-directory: www/utils/packages/scripts
         run: 'yarn check:pr-files-count ${{ github.ref_name }}'
         id: pr-files
 
@@ -121,6 +137,7 @@ jobs:
 
       - name: Vale Linter
         uses: errata-ai/vale-action@reviewdog
+        if: ${{ steps.pr-files.outputs.files_lt_threshold == 'true' }}
         with:
           files: ${{ steps.directories.outputs.LIST }}
           fail_on_error: true
@@ -145,6 +162,14 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Install www/utils Dependencies
+        run: yarn
+        working-directory: www/utils
+
+      - name: Build packages
+        run: yarn build
+        working-directory: www/utils
+
       # reviewdog throws an error when the number
       # of file changes in a PR is > 300, so
       # we retrieve the number of changed files
@@ -152,7 +177,7 @@ jobs:
       # less than 300. This is to avoid a PR hanging in
       # an error state
       - name: Get PR files number
-        working-directory: docs-util/packages/scripts
+        working-directory: www/utils/packages/scripts
         run: 'yarn check:pr-files-count ${{ github.ref_name }}'
         id: pr-files
 
@@ -162,8 +187,8 @@ jobs:
         id: directories
 
       - name: Vale Linter
-        if: ${{ steps.pr-files.outputs.files_lt_threshold == 'true' }}
         uses: errata-ai/vale-action@reviewdog
+        if: ${{ steps.pr-files.outputs.files_lt_threshold == 'true' }}
         with:
           files: ${{ steps.directories.outputs.LIST }}
           fail_on_error: true
@@ -188,13 +213,13 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Install docs-util Dependencies
+      - name: Install www/utils Dependencies
         run: yarn
-        working-directory: docs-util
+        working-directory: www/utils
 
       - name: Build packages
         run: yarn build
-        working-directory: docs-util
+        working-directory: www/utils
 
       # reviewdog throws an error when the number
       # of file changes in a PR is > 300, so
@@ -203,7 +228,7 @@ jobs:
       # less than 300. This is to avoid a PR hanging in
       # an error state
       - name: Get PR files number
-        working-directory: docs-util/packages/scripts
+        working-directory: www/utils/packages/scripts
         run: 'yarn check:pr-files-count ${{ github.ref_name }}'
         id: pr-files
 
@@ -240,13 +265,13 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Install docs-util Dependencies
+      - name: Install www/utils Dependencies
         run: yarn
-        working-directory: docs-util
+        working-directory: www/utils
 
       - name: Build packages
         run: yarn build
-        working-directory: docs-util
+        working-directory: www/utils
 
       # reviewdog throws an error when the number
       # of file changes in a PR is > 300, so
@@ -255,7 +280,7 @@ jobs:
       # less than 300. This is to avoid a PR hanging in
       # an error state
       - name: Get PR files number
-        working-directory: docs-util/packages/scripts
+        working-directory: www/utils/packages/scripts
         run: 'yarn check:pr-files-count ${{ github.ref_name }}'
         id: pr-files
 
@@ -321,6 +346,10 @@ jobs:
         working-directory: www
         run: yarn install
 
+      - name: Build packages
+        working-directory: www
+        run: yarn build:packages
+
       - name: Run Eslint
         working-directory: www
         run: yarn lint

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

@@ -9,7 +9,7 @@ on:
   workflow_dispatch:
     inputs:
       referenceName:
-        description: 'Reference to Generate. Use either `all` or a name of a config file in `docs-util/packages/typedoc-config` such as `product`.'
+        description: 'Reference to Generate. Use either `all` or a name of a config file in `www/utils/packages/typedoc-config` such as `product`.'
         required: false
         default: 'all'
 
@@ -48,30 +48,30 @@ jobs:
 
       - name: Install Workspace dependencies
         run: yarn install
-        working-directory: docs-util
+        working-directory: www/utils
 
       - name: Build Workspace dependencies
         run: yarn build
-        working-directory: docs-util
+        working-directory: www/utils
 
       - name: Generate References
         if: ${{ github.event_name == 'workflow_dispatch' }}
         run: "yarn start generate ${{ github.event.inputs.referenceName }} --merge"
-        working-directory: docs-util/packages/typedoc-generate-references
+        working-directory: www/utils/packages/typedoc-generate-references
 
       - name: Generate References
         if: ${{ github.event_name != 'workflow_dispatch' }}
         run: "yarn start generate all --merge"
-        working-directory: docs-util/packages/typedoc-generate-references
+        working-directory: www/utils/packages/typedoc-generate-references
 
       - name: Generate Changeset
         run: "yarn generate:changeset"
-        working-directory: docs-util/packages/scripts
+        working-directory: www/utils/packages/scripts
 
       - name: Get PR Message
         id: pr-message
         run: yarn generate:message
-        working-directory: docs-util/packages/scripts
+        working-directory: www/utils/packages/scripts
 
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v4

.github/workflows/generate-docblocks.yml

@@ -22,18 +22,18 @@ jobs:
       - name: Install Dependencies
         run: yarn
 
-      - name: Install docs-util Dependencies
+      - name: Install www/utils Dependencies
         run: yarn
-        working-directory: docs-util
+        working-directory: www/utils
 
       - name: Build packages
         run: yarn build
-        working-directory: docs-util
+        working-directory: www/utils
       
       - name: Check Commit
         id: check-commit
         run: 'yarn check:release-commit ${{ github.sha }}'
-        working-directory: docs-util/packages/scripts
+        working-directory: www/utils/packages/scripts
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           GIT_OWNER: ${{ github.repository_owner }}
@@ -42,7 +42,7 @@ jobs:
       - name: Run docblock generator
         if: steps.check-commit.outputs.is_release_commit == 'true'
         run: "yarn start run:release"
-        working-directory: docs-util/packages/docblock-generator
+        working-directory: www/utils/packages/docblock-generator
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           GIT_OWNER: ${{ github.repository_owner }}
@@ -51,7 +51,7 @@ jobs:
       - name: Generate Changeset
         if: steps.check-commit.outputs.is_release_commit == 'true'
         run: "yarn generate:changeset"
-        working-directory: docs-util/packages/scripts
+        working-directory: www/utils/packages/scripts
 
       - name: Create Pull Request
         if: steps.check-commit.outputs.is_release_commit == 'true'
@@ -78,18 +78,18 @@ jobs:
       - name: Install Dependencies
         run: yarn
 
-      - name: Install docs-util Dependencies
+      - name: Install www/utils Dependencies
         run: yarn
-        working-directory: docs-util
+        working-directory: www/utils
 
       - name: Build packages
         run: yarn build
-        working-directory: docs-util
+        working-directory: www/utils
       
       - name: Check Commit
         id: check-commit
         run: 'yarn check:release-commit ${{ github.sha }}'
-        working-directory: docs-util/packages/scripts
+        working-directory: www/utils/packages/scripts
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           GIT_OWNER: ${{ github.repository_owner }}
@@ -98,7 +98,7 @@ jobs:
       - name: Run docblock generator
         if: steps.check-commit.outputs.is_release_commit == 'true'
         run: "yarn start run ../../../packages/medusa/src/api-v2 --type oas && yarn start clean:oas"
-        working-directory: docs-util/packages/docblock-generator
+        working-directory: www/utils/packages/docblock-generator
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           GIT_OWNER: ${{ github.repository_owner }}
@@ -113,4 +113,4 @@ jobs:
           title: "chore(docs): Generated OAS"
           body: "This PR holds all generated OAS for the upcoming release."
           branch: "chore/generate-oas"
-          add-paths: docs-util/oas-output/**
+          add-paths: www/utils/generated/oas-output/**

.github/workflows/generate-public-references.yml

@@ -42,13 +42,13 @@ jobs:
       - name: Generate API Reference
         run: yarn openapi:generate
 
-      - name: Install and Build docs-util dependencies
+      - name: Install and Build www/utils dependencies
         run: yarn && yarn build
-        working-directory: docs-util
+        working-directory: www/utils
 
       - name: Generate Changeset
         run: "yarn generate:changeset"
-        working-directory: docs-util/packages/scripts
+        working-directory: www/utils/packages/scripts
 
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v4
@@ -92,13 +92,13 @@ jobs:
       - name: Generate API Reference (v2)
         run: yarn openapi:generate --v2
 
-      - name: Install and Build docs-util dependencies
+      - name: Install and Build www/utils dependencies
         run: yarn && yarn build
-        working-directory: docs-util
+        working-directory: www/utils
 
       - name: Generate Changeset
         run: "yarn generate:changeset"
-        working-directory: docs-util/packages/scripts
+        working-directory: www/utils/packages/scripts
 
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v4
@@ -141,19 +141,19 @@ jobs:
 
       - name: Install Workspace dependencies
         run: yarn install
-        working-directory: docs-util
+        working-directory: www/utils
 
       - name: Build Workspace dependencies
         run: yarn build
-        working-directory: docs-util
+        working-directory: www/utils
 
       - name: Generate UI Specs
         run: yarn generate:ui
-        working-directory: docs-util/packages/react-docs-generator
+        working-directory: www/utils/packages/react-docs-generator
 
       - name: Generate Changeset
         run: "yarn generate:changeset"
-        working-directory: docs-util/packages/scripts
+        working-directory: www/utils/packages/scripts
 
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v4

docs-util/packages/typedoc-config/_models.js

@@ -1,10 +0,0 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-const getConfig = require("./utils/get-config")
-
-module.exports = (options) => {
-  return getConfig({
-    ...options,
-    generateModelsDiagram: true,
-    diagramAddToFile: options.entryPointPath,
-  })
-}

docs-util/packages/typedoc-config/api-key-models.js

@@ -1,8 +0,0 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-const modelConfig = require("./_models")
-
-module.exports = modelConfig({
-  entryPointPath: "packages/api-key/src/models/index.ts",
-  name: "api-key-models",
-  tsConfigName: "api-key.json",
-})

docs-util/packages/typedoc-config/api-key.js

@@ -1,7 +0,0 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-const modulesConfig = require("./_modules")
-
-module.exports = modulesConfig({
-  entryPointPath: "packages/types/src/api-key/service.ts",
-  name: "api-key",
-})

docs-util/packages/typedoc-config/customer-models.js

@@ -1,8 +0,0 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-const modelConfig = require("./_models")
-
-module.exports = modelConfig({
-  entryPointPath: "packages/customer/src/models/index.ts",
-  name: "customer-models",
-  tsConfigName: "customer.json",
-})

docs-util/packages/typedoc-config/customer.js

@@ -1,7 +0,0 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-const modulesConfig = require("./_modules")
-
-module.exports = modulesConfig({
-  entryPointPath: "packages/types/src/customer/service.ts",
-  name: "customer",
-})

docs-util/packages/typedoc-config/inventory-models.js

@@ -1,8 +0,0 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-const modelConfig = require("./_models")
-
-module.exports = modelConfig({
-  entryPointPath: "packages/inventory-next/src/models/index.ts",
-  name: "inventory-models",
-  tsConfigName: "inventory.json",
-})

docs-util/packages/typedoc-config/pricing-models.js

@@ -1,8 +0,0 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-const modelConfig = require("./_models")
-
-module.exports = modelConfig({
-  entryPointPath: "packages/pricing/src/models/index.ts",
-  name: "pricing-models",
-  tsConfigName: "pricing.json",
-})

docs-util/packages/typedoc-config/product-models.js

@@ -1,8 +0,0 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-const modelConfig = require("./_models")
-
-module.exports = modelConfig({
-  entryPointPath: "packages/product/src/models/index.ts",
-  name: "product-models",
-  tsConfigName: "product.json",
-})

docs-util/packages/typedoc-config/product.json

@@ -1,10 +0,0 @@
-{
-  "$schema": "http://json.schemastore.org/tsconfig",
-  "extends": [
-    "../../../packages/product/tsconfig.json"
-  ],
-  "include": [
-    "../../../packages/product/src",
-    "../../../packages/utils/src/product"
-  ]
-}

docs-util/packages/typedoc-config/promotion-models.js

@@ -1,8 +0,0 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-const modelConfig = require("./_models")
-
-module.exports = modelConfig({
-  entryPointPath: "packages/promotion/src/models/index.ts",
-  name: "promotion-models",
-  tsConfigName: "promotion.json",
-})

docs-util/packages/typedoc-config/promotion.js

@@ -1,7 +0,0 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-const modulesConfig = require("./_modules")
-
-module.exports = modulesConfig({
-  entryPointPath: "packages/types/src/promotion/service.ts",
-  name: "promotion",
-})

docs-util/packages/typedoc-config/sales-channel-models.js

@@ -1,8 +0,0 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-const modelConfig = require("./_models")
-
-module.exports = modelConfig({
-  entryPointPath: "packages/sales-channel/src/models/index.ts",
-  name: "sales-channel-models",
-  tsConfigName: "sales-channel.json",
-})

docs-util/packages/typedoc-config/sales-channel.js

@@ -1,7 +0,0 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-const modulesConfig = require("./_modules")
-
-module.exports = modulesConfig({
-  entryPointPath: "packages/types/src/sales-channel/service.ts",
-  name: "sales-channel",
-})

docs-util/packages/typedoc-config/stock-location-models.js

@@ -1,8 +0,0 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-const modelConfig = require("./_models")
-
-module.exports = modelConfig({
-  entryPointPath: "packages/stock-location-next/src/models/index.ts",
-  name: "stock-location-models",
-  tsConfigName: "stock-location.json",
-})

docs-util/packages/typedoc-config/store-models.js

@@ -1,8 +0,0 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-const modelConfig = require("./_models")
-
-module.exports = modelConfig({
-  entryPointPath: "packages/store/src/models/index.ts",
-  name: "store-models",
-  tsConfigName: "store.json",
-})

docs-util/packages/typedoc-config/store.js

@@ -1,7 +0,0 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-const modulesConfig = require("./_modules")
-
-module.exports = modulesConfig({
-  entryPointPath: "packages/types/src/store/service.ts",
-  name: "store",
-})

docs-util/packages/typedoc-generate-references/src/constants/general.ts

@@ -1,11 +0,0 @@
-import path from "path"
-import dirname from "../utils/dirname.js"
-
-export const rootPathPrefix = path.join(dirname(), "..", "..", "..", "..", "..")
-
-export const docsUtilPathPrefix = path.join(rootPathPrefix, "docs-util")
-
-export const jsonOutputPathPrefix = path.join(
-  docsUtilPathPrefix,
-  "typedoc-json-output"
-)

www/apps/resources/references/order/interfaces/order.UpdateOrderShippingMethodTaxLineDTO/page.mdx

@@ -4,6 +4,6 @@ displayed_sidebar: orderReference
 
 import { TypeList } from "docs-ui"
 
-# UpdateOrderShippingMethodTaxLineDTO
+# UpdateOrderTaxLineDTO
 
-<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"[BigNumberInput](../../types/order.BigNumberInput/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="UpdateOrderShippingMethodTaxLineDTO"/>
+<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"[BigNumberInput](../../types/order.BigNumberInput/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="UpdateOrderTaxLineDTO"/>

www/apps/resources/references/order/interfaces/order.UpdateOrderTaxLineDTO/page.mdx

@@ -4,6 +4,6 @@ displayed_sidebar: orderReference
 
 import { TypeList } from "docs-ui"
 
-# UpdateOrderTaxLineDTO
+# UpdateOrderShippingMethodTaxLineDTO
 
-<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"[BigNumberInput](../../types/order.BigNumberInput/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="UpdateOrderTaxLineDTO"/>
+<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"[BigNumberInput](../../types/order.BigNumberInput/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="UpdateOrderShippingMethodTaxLineDTO"/>

www/package.json

@@ -12,6 +12,7 @@
     "build:docs": "turbo run build --filter=docs-v2",
     "build:resources": "turbo run build --filter=resources",
     "build:user-guide": "turbo run build --filter=user-guide",
+    "build:packages": "turbo run build --filter='./packages/*'",
     "start": "turbo run start:monorepo",
     "dev": "turbo run dev:monorepo",
     "lint": "turbo run lint",

www/utils/.eslintrc.js

@@ -81,7 +81,7 @@ module.exports = {
   ignorePatterns: [
     ".eslintrc.js",
     "dist",
-    "oas-output"
+    "generated"
   ],
   overrides: [
     {
@@ -94,9 +94,10 @@ module.exports = {
       parserOptions: {
         project: [
           "./tsconfig.json",
+          "./packages/docblock-generator/tsconfig.json",
           "./packages/react-docs-generator/tsconfig.json",
           "./packages/scripts/tsconfig.json",
-          "./packages/typedoc-config/tsconfig.json",
+          "./packages/typedoc-generate-references/tsconfig.json",
           "./packages/typedoc-plugin-custom/tsconfig.json",
           "./packages/typedoc-markdown-medusa-plugin/tsconfig.json",
           "./packages/types/tsconfig.json",