Skip to content

Commit

Permalink
docs: rearrange user guide (#2127)
Browse files Browse the repository at this point in the history
* added lists guide

* restructure existing guides

* added new pages after restructuring

* added blank pages + rearranged sidebar
  • Loading branch information
shahednasser authored Aug 30, 2022
1 parent 5a68665 commit f3170ba
Show file tree
Hide file tree
Showing 57 changed files with 1,331 additions and 1,309 deletions.
6 changes: 6 additions & 0 deletions docs/content/user-guide/customers/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"position": 5,
"collapsed": false,
"link": null,
"label": "Customers"
}
11 changes: 11 additions & 0 deletions docs/content/user-guide/customers/groups.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 3
---

# Manage Customer Groups

:::note

This guide is coming soon.

:::
36 changes: 36 additions & 0 deletions docs/content/user-guide/customers/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
sidebar_position: 1
---

# Customers Overview

In this document, you’ll get an overview of the customer listing page and all the things you can do with it.

## Overview

You can find the list of signed up customers on your store in the Customers page. For each of those customers, you can view details such as their orders, or personal information.

Part of the Customers domain is also Customer Groups. Customer groups allow you to put together a set of customers for business purposes. For example, you can create a VIP customer group for customers that you want to give special discounts.

---

## View List of Customers

You can view the list of available customers in your ecommerce store by clicking on Customers from the sidebar menu.

In the list, you can see customer details such as the customer’s name, email address, and the number of orders.

---

## View List of Customer Groups

You can view the list of customer groups on the Customer Groups page by clicking on the grey Groups headline next to the Customers headline.

In the list, you can see group details such as the group’s title and the number of customers in the group.

---

## Learn More About Customers

- [Manage and View a Customer’s Details](./manage.md)
- [Manage and View a Customer Group](./groups.md)
54 changes: 0 additions & 54 deletions docs/content/user-guide/customers/index.mdx

This file was deleted.

11 changes: 11 additions & 0 deletions docs/content/user-guide/customers/manage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 2
---

# Manage Customers

:::note

This guide is coming soon.

:::
6 changes: 6 additions & 0 deletions docs/content/user-guide/discounts/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"position": 6,
"collapsed": false,
"link": null,
"label": "Discounts"
}
11 changes: 11 additions & 0 deletions docs/content/user-guide/discounts/conditions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 2
---

# Discount Conditions Overview

:::note

This guide is coming soon.

:::
11 changes: 11 additions & 0 deletions docs/content/user-guide/discounts/create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 3
---

# Create a Discount

:::note

This guide is coming soon.

:::
11 changes: 11 additions & 0 deletions docs/content/user-guide/discounts/edit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 4
---

# Edit a Discount

:::note

This guide is coming soon.

:::
35 changes: 35 additions & 0 deletions docs/content/user-guide/discounts/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
sidebar_position: 1
---

# Discounts Overview

In this document, you’ll get an overview of the customer listing page and everything you can do with it.

## Overview

You can create discounts of different types in Medusa that customers use on checkout:

- **Percentage Discounts** to deduct a percentage of the total amount of an order.
- **Fixed Discounts** to deduct a fixed amount from the total amount of an order.
- **Free Shipping** to override the delivery amount of an order and make it free.

Discounts are in the form of a code that your customers can use. You can set options for a discount such as a start and an end date.

You can also specify conditions for discounts, such as applying them for specific products or shipping options.

---

## View List of Discounts

You can view the list of available discounts in your ecommerce store by clicking on Discounts from the sidebar menu.

In the list, you can see discount details such as the code, description, amount, and status.

---

## Learn More About Discounts

- [Discount Conditions Overview](./conditions.md)
- [Create a Discount](./create.md)
- [Edit a Discount](./edit.md)
88 changes: 0 additions & 88 deletions docs/content/user-guide/discounts/index.mdx

This file was deleted.

6 changes: 6 additions & 0 deletions docs/content/user-guide/gift-cards/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"position": 7,
"collapsed": false,
"link": null,
"label": "Gift Cards"
}
11 changes: 11 additions & 0 deletions docs/content/user-guide/gift-cards/custom.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 3
---

# Manage Custom Gift Cards

:::note

This guide is coming soon.

:::
18 changes: 18 additions & 0 deletions docs/content/user-guide/gift-cards/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
sidebar_position: 1
---

# Gift Cards Overview

In this document, you’ll learn about how Gift Cards in Medusa work.

## Overview

In Medusa, there’s one main gift card. A gift card can have multiple denominations. For example, a Gift Card can have the amounts of $20 and $50, and customers can buy one of these denominations.

You can also create custom gift cards in Medusa. These cards can be created and sent directly to a customer’s email.

## Learn More About Gift Cards

- [Manage Gift Cards](./manage.mdx)
- [Manage Custom Gift Cards](./custom.md)
Loading

0 comments on commit f3170ba

Please sign in to comment.