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,61 @@
+title: Sales Channel
+description: >-
+  A Sales Channel is a method a business offers its products for purchase for
+  the customers. For example, a Webshop can be a sales channel, and a mobile app
+  can be another.
+type: object
+required:
+  - created_at
+  - deleted_at
+  - description
+  - id
+  - is_disabled
+  - name
+  - updated_at
+properties:
+  id:
+    description: The sales channel's ID
+    type: string
+    example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A
+  name:
+    description: The name of the sales channel.
+    type: string
+    example: Market
+  description:
+    description: The description of the sales channel.
+    nullable: true
+    type: string
+    example: Multi-vendor market
+  is_disabled:
+    description: Specify if the sales channel is enabled or disabled.
+    type: boolean
+    default: false
+  locations:
+    description: The details of the stock locations related to the sales channel.
+    type: array
+    x-expandable: locations
+    items:
+      $ref: ./SalesChannelLocation.yaml
+  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
+  deleted_at:
+    description: The date with timezone at which the resource was deleted.
+    nullable: true
+    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