docs: create docs workspace (#5174)

* docs: migrate ui docs to docs universe

* created yarn workspace

* added eslint and tsconfig configurations

* fix eslint configurations

* fixed eslint configurations

* shared tailwind configurations

* added shared ui package

* added more shared components

* migrating more components

* made details components shared

* move InlineCode component

* moved InputText

* moved Loading component

* Moved Modal component

* moved Select components

* Moved Tooltip component

* moved Search components

* moved ColorMode provider

* Moved Notification components and providers

* used icons package

* use UI colors in api-reference

* moved Navbar component

* used Navbar and Search in UI docs

* added Feedback to UI docs

* general enhancements

* fix color mode

* added copy colors file from ui-preset

* added features and enhancements to UI docs

* move Sidebar component and provider

* general fixes and preparations for deployment

* update docusaurus version

* adjusted versions

* fix output directory

* remove rootDirectory property

* fix yarn.lock

* moved code component

* added vale for all docs MD and MDX

* fix tests

* fix vale error

* fix deployment errors

* change ignore commands

* add output directory

* fix docs test

* general fixes

* content fixes

* fix announcement script

* added changeset

* fix vale checks

* added nofilter option

* fix vale error

www/apps/api-reference/specs/admin/components/schemas/ShippingMethod.yaml

@@ -0,0 +1,119 @@
+title: Shipping Method
+description: >-
+  A Shipping Method represents a way in which an Order or Return can be shipped.
+  Shipping Methods are created from a Shipping Option, but may contain
+  additional details that can be necessary for the Fulfillment Provider to
+  handle the shipment. If the shipping method is created for a return, it may be
+  associated with a claim or a swap that the return is part of.
+type: object
+required:
+  - cart_id
+  - claim_order_id
+  - data
+  - id
+  - order_id
+  - price
+  - return_id
+  - shipping_option_id
+  - swap_id
+properties:
+  id:
+    description: The shipping method's ID
+    type: string
+    example: sm_01F0YET7DR2E7CYVSDHM593QG2
+  shipping_option_id:
+    description: The ID of the Shipping Option that the Shipping Method is built from.
+    type: string
+    example: so_01G1G5V27GYX4QXNARRQCW1N8T
+  order_id:
+    description: The ID of the order that the shipping method is used in.
+    nullable: true
+    type: string
+    example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
+  order:
+    description: The details of the order that the shipping method is used in.
+    x-expandable: order
+    nullable: true
+    type: object
+  claim_order_id:
+    description: The ID of the claim that the shipping method is used in.
+    nullable: true
+    type: string
+    example: null
+  claim_order:
+    description: The details of the claim that the shipping method is used in.
+    x-expandable: claim_order
+    nullable: true
+    type: object
+  cart_id:
+    description: The ID of the cart that the shipping method is used in.
+    nullable: true
+    type: string
+    example: cart_01G8ZH853Y6TFXWPG5EYE81X63
+  cart:
+    description: The details of the cart that the shipping method is used in.
+    x-expandable: cart
+    nullable: true
+    type: object
+  swap_id:
+    description: The ID of the swap that the shipping method is used in.
+    nullable: true
+    type: string
+    example: null
+  swap:
+    description: The details of the swap that the shipping method is used in.
+    x-expandable: swap
+    nullable: true
+    type: object
+  return_id:
+    description: The ID of the return that the shipping method is used in.
+    nullable: true
+    type: string
+    example: null
+  return_order:
+    description: The details of the return that the shipping method is used in.
+    x-expandable: return_order
+    nullable: true
+    type: object
+  shipping_option:
+    description: The details of the shipping option the method was created from.
+    x-expandable: shipping_option
+    nullable: true
+    $ref: ./ShippingOption.yaml
+  tax_lines:
+    description: The details of the tax lines applied on the shipping method.
+    type: array
+    x-expandable: tax_lines
+    items:
+      $ref: ./ShippingMethodTaxLine.yaml
+  price:
+    description: >-
+      The amount to charge for the Shipping Method. The currency of the price is
+      defined by the Region that the Order that the Shipping Method belongs to
+      is a part of.
+    type: integer
+    example: 200
+  data:
+    description: >-
+      Additional data that the Fulfillment Provider needs to fulfill the
+      shipment. This is used in combination with the Shipping Options data, and
+      may contain information such as a drop point id.
+    type: object
+    example: {}
+  includes_tax:
+    description: Whether the shipping method price include tax
+    type: boolean
+    x-featureFlag: tax_inclusive_pricing
+    default: false
+  subtotal:
+    description: The subtotal of the shipping
+    type: integer
+    example: 8000
+  total:
+    description: The total amount of the shipping
+    type: integer
+    example: 8200
+  tax_total:
+    description: The total of tax
+    type: integer
+    example: 0