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
2023-09-21 20:57:15 +03:00
parent 19c5d5ba36
commit fa7c94b4cc
3209 changed files with 32188 additions and 31018 deletions
@@ -0,0 +1,90 @@
+title: Tax Rate
+description: >-
+  A Tax Rate can be used to define a custom rate to charge on specified
+  products, product types, and shipping options within a given region.
+type: object
+required:
+  - code
+  - created_at
+  - id
+  - metadata
+  - name
+  - rate
+  - region_id
+  - updated_at
+properties:
+  id:
+    description: The tax rate's ID
+    type: string
+    example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
+  rate:
+    description: The numeric rate to charge
+    nullable: true
+    type: number
+    example: 10
+  code:
+    description: A code to identify the tax type by
+    nullable: true
+    type: string
+    example: tax01
+  name:
+    description: A human friendly name for the tax
+    type: string
+    example: Tax Example
+  region_id:
+    description: The ID of the region that the rate belongs to.
+    type: string
+    example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
+  region:
+    description: The details of the region that the rate belongs to.
+    x-expandable: region
+    nullable: true
+    type: object
+  products:
+    description: The details of the products that belong to this tax rate.
+    type: array
+    x-expandable: products
+    items:
+      $ref: ./Product.yaml
+  product_types:
+    description: The details of the product types that belong to this tax rate.
+    type: array
+    x-expandable: product_types
+    items:
+      $ref: ./ProductType.yaml
+  shipping_options:
+    description: The details of the shipping options that belong to this tax rate.
+    type: array
+    x-expandable: shipping_options
+    items:
+      $ref: ./ShippingOption.yaml
+  product_count:
+    description: The count of products
+    type: integer
+    example: 10
+  product_type_count:
+    description: The count of product types
+    type: integer
+    example: 2
+  shipping_option_count:
+    description: The count of shipping options
+    type: integer
+    example: 1
+  created_at:
+    description: The date with timezone at which the resource was created.
+    type: string
+    format: date-time
+  updated_at:
+    description: The date with timezone at which the resource was updated.
+    type: string
+    format: date-time
+  metadata:
+    description: An optional key-value map with additional details
+    nullable: true
+    type: object
+    example:
+      car: white
+    externalDocs:
+      description: Learn about the metadata attribute, and how to delete and update it.
+      url: >-
+        https://docs.medusajs.com/development/entities/overview#metadata-attribute