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
This commit is contained in:
Shahed Nasser
2023-09-21 20:57:15 +03:00
committed by GitHub
parent 19c5d5ba36
commit fa7c94b4cc
3209 changed files with 32188 additions and 31018 deletions
@@ -0,0 +1,113 @@
---
description: "Discounts are deductions in the checkout total that are generally used for marketing and promotional purposes. Learn about the available features and guides."
---
import DocCardList from '@theme/DocCardList';
import DocCard from '@theme/DocCard';
import Icons from '@theme/Icon';
# Discounts
Discounts are deductions in the checkout total that are generally used for marketing and promotional purposes. This overview introduces the available features related to discounts.
:::note
Not a developer? Check out the [Discounts user guide](../../user-guide/discounts/index.md).
:::
## Features
### Discounts Management
Admins can create discounts with various conditions and rules that can be used to deduct a fixed or percentage amount from the cart total, or that can be used for free shipping.
<DocCardList colSize={6} items={[
{
type: 'link',
href: '/modules/discounts/admin/manage-discounts',
label: 'Admin: Manage Discounts',
customProps: {
icon: Icons['academic-cap-solid'],
description: 'Learn how to manage discounts using Admin APIs.'
}
},
{
type: 'link',
href: '/user-guide/discounts/manage',
label: 'User Guide: Manage Discounts',
customProps: {
icon: Icons['users-solid'],
description: 'Learn how to manage discounts using Medusa Admin.'
}
},
]} />
### Applying Discounts during Checkout
Customers can benefit from discounts by using a discount code during checkout.
<DocCardList colSize={6} items={[
{
type: 'link',
href: '/modules/discounts/storefront/use-discounts-in-checkout',
label: 'Storefront: Use Discounts in Checkout',
customProps: {
icon: Icons['academic-cap-solid'],
description: 'Learn how to use discounts during checkout.'
}
},
{
type: 'link',
href: 'https://docs.medusajs.com/api/store#carts_getcartscart',
label: 'Store APIs: Discounts',
customProps: {
icon: Icons['server-solid'],
description: 'Check available Store REST APIs for Discounts with carts.'
}
},
]} />
---
## Understand the Architecture
Learn how discount-related entities and concepts are built, their relation to other modules, and more.
<DocCard item={{
type: 'link',
href: '/modules/discounts',
label: 'Architecture: Discounts',
customProps: {
icon: Icons['circle-stack-solid'],
description: 'Learn about the Discount architecture.'
}
}}
/>
---
## Related Modules
Discover Discounts relation to other modules in Medusa
<DocCardList colSize={6} items={[
{
type: 'link',
href: '/modules/carts-and-checkout/overview',
label: 'Cart and Checkout',
customProps: {
icon: Icons['shopping-cart-solid'],
description: 'Customers can apply discounts during checkout.'
}
},
{
type: 'link',
href: '/modules/products/overview',
label: 'Product',
customProps: {
icon: Icons['tag-solid'],
description: 'Discounts can be associated with specific products.'
}
},
]} />