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,155 @@
+---
+description: "Customers are individuals that make purchases in your store. Learn about the available features and guides."
+---
+
+import DocCardList from '@theme/DocCardList';
+import Icons from '@theme/Icon';
+
+# Customers
+
+Customers are individuals that make purchases in your store. This overview introduces the available features related to customers.
+
+:::note
+
+Not a developer? Check out the [Customers user guide](../../user-guide/customers/index.md).
+
+:::
+
+## Features
+
+### Customer Accounts
+
+Customers can make purchases as guests, or they can create an account.
+
+When a customer creates an account, they can manage their details and review their order history.
+
+An admin can manage all customers and their details.
+
+<DocCardList colSize={4} items={[
+  {
+    type: 'link',
+    href: '/modules/customers/storefront/implement-customer-profiles',
+    label: 'Storefront: Add Customer Profiles',
+    customProps: {
+      icon: Icons['academic-cap-solid'],
+      description: 'Learn how to implement customer accounts in a storefront.',
+    }
+  },
+  {
+    type: 'link',
+    href: '/modules/customers/admin/manage-customers',
+    label: 'Admin: Manage Customers',
+    customProps: {
+      icon: Icons['academic-cap-solid'],
+      description: 'Learn how to manage customers using Admin APIs.',
+    }
+  },
+  {
+    type: 'link',
+    href: '/user-guide/customers/manage',
+    label: 'User Guide: Manage Customers',
+    customProps: {
+      icon: Icons['users-solid'],
+      description: 'Learn how to manage customers in Medusa Admin.'
+    }
+  },
+]} />
+
+### Customer Groups
+
+Admins can segment customers or assign them to different customer groups. This can be useful for marketing purposes.
+
+For example, an admin can specify a different pricing or special discounts for specific customer groups.
+
+<DocCardList colSize={4} items={[
+  {
+    type: 'link',
+    href: '/modules/customers/admin/manage-customer-groups',
+    label: 'Admin: Manage Customer Groups',
+    customProps: {
+      icon: Icons['academic-cap-solid'],
+      description: 'Learn how to manage customer groups using Admin APIs.',
+    }
+  },
+  {
+    type: 'link',
+    href: '/user-guide/customers/groups',
+    label: 'User Guide: Customer Groups',
+    customProps: {
+      icon: Icons['users-solid'],
+      description: 'Learn how to manage customer groups in Medusa Admin.'
+    }
+  },
+  {
+    type: 'link',
+    href: 'https://docs.medusajs.com/api/admin#customer-groups',
+    label: 'Admin APIs: Customer Groups',
+    customProps: {
+      icon: Icons['server-solid'],
+      description: 'Check available Admin REST APIs for Customer Groups.'
+    }
+  },
+]} />
+
+---
+
+## Understand the Architecture
+
+Learn how Customer-related entities are built, their relation to other modules, and more.
+
+<DocCardList colSize={6} items={[
+  {
+    type: 'link',
+    href: '/modules/customers',
+    label: 'Architecture: Customer',
+    customProps: {
+      icon: Icons['circle-stack-solid'],
+      description: 'Learn about the Customer Architecture.',
+    }
+  },
+  {
+    type: 'link',
+    href: '/modules/customers/customer-groups',
+    label: 'Architecture: Customer Group',
+    customProps: {
+      icon: Icons['circle-stack-solid'],
+      description: 'Learn about the Customer Group Architecture.',
+    }
+  },
+]} />
+
+---
+
+## Related Modules
+
+Discover Customers’ relation to other modules in Medusa.
+
+<DocCardList colSize={4} items={[
+  {
+    type: 'link',
+    href: '/modules/orders/overview',
+    label: 'Orders',
+    customProps: {
+      icon: Icons['check-circle-solid'],
+      description: 'Customers can place orders, request returns and exchanges, and more.'
+    }
+  },
+  {
+    type: 'link',
+    href: '/modules/discounts/overview',
+    label: 'Discounts',
+    customProps: {
+      icon: Icons['academic-cap-solid'],
+      description: 'Discounts can be associated with a specific customer group.'
+    }
+  },
+  {
+    type: 'link',
+    href: '/modules/price-lists/overview',
+    label: 'Price Lists',
+    customProps: {
+      icon: Icons['currency-dollar-solid'],
+      description: 'Set special prices for specific customer groups.'
+    }
+  },
+]} />