Skip to content

Commit

Permalink
docs: Restore user guide docs
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelbromley committed Aug 10, 2024
1 parent 56b0df9 commit 2f2248c
Show file tree
Hide file tree
Showing 11 changed files with 53 additions and 31 deletions.
4 changes: 0 additions & 4 deletions docs/docs/user-guide/catalog/index.md

This file was deleted.

5 changes: 2 additions & 3 deletions docs/docs/user-guide/catalog/products.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Products"
weight: 0
---

# Products
Expand All @@ -21,7 +20,7 @@ In the diagram above you'll notice that it is the ProductVariants which have an

## Tracking Inventory

Vendure can track the stock levels of each of your ProductVariants. This is done by setting the "track inventory" option to "track" (or "inherit from global settings" if the [global setting]({{< relref "/user-guide/settings/global-settings" >}}) is set to track).
Vendure can track the stock levels of each of your ProductVariants. This is done by setting the "track inventory" option to "track" (or "inherit from global settings" if the [global setting](/user-guide/settings/global-settings) is set to track).

![./screen-inventory.webp](./screen-inventory.webp)

Expand All @@ -33,4 +32,4 @@ When tracking inventory:

### Back orders

Back orders can be enabled by setting a **negative value** as the "Out-of-stock threshold". This can be done via [global settings]({{< relref "/user-guide/settings/global-settings" >}}) or on a per-variant basis.
Back orders can be enabled by setting a **negative value** as the "Out-of-stock threshold". This can be done via [global settings](/user-guide/settings/global-settings) or on a per-variant basis.
7 changes: 1 addition & 6 deletions docs/docs/user-guide/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
---
title: "Administrator Guide"
weight: 1
---

# Administrator Guide
# Vendure User Guide

This section is for store owners and staff who are charged with running a Vendure-based store.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/user-guide/localization/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Vendure supports **admin-facing** (Admin API and Admin UI) localization by allow

## How to enable languages

To select the set of languages you wish to create translations for, set them in the [global settings]({{< relref "/user-guide/settings/global-settings" >}}).
To select the set of languages you wish to create translations for, set them in the [global settings](/user-guide/settings/global-settings).

Once more than one language is enabled, you will see a language switcher appear when editing the object types listed above.

Expand Down
8 changes: 2 additions & 6 deletions docs/docs/user-guide/orders/draft-orders.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ title: "Draft Orders"

# Draft Orders

{{% alert "warning" %}}
Note: Draft Orders are available from Vendure v1.8+
{{% /alert %}}

Draft Orders are used when an Administrator would like to manually create an order via the Admin UI. For example, this can be useful when:

- A customer phones up to place an order
Expand All @@ -26,7 +22,7 @@ From there you can:

Once ready, click the **"Complete draft"** button to convert this Order from a Draft into a regular Order. At this stage the order can be paid for, and you can manually record the payment details.

{{% alert "primary" %}}
:::note
Note: Draft Orders do not appear in a Customer's order history in the storefront (Shop API) while still
in the "Draft" state.
{{% /alert %}}
:::
8 changes: 4 additions & 4 deletions docs/docs/user-guide/promotions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ A condition defines the criteria that must be met for the Promotion to be activa

* If the order total is at least $X
* Buy at least X of a certain product
* But at least X of any product with the specified [FacetValues]({{< relref "/user-guide/catalog/facets" >}})
* If the customer is a member of the specified [Customer Group]({{< relref "/user-guide/customers" >}}#customer-groups)
* But at least X of any product with the specified [FacetValues](/user-guide/catalog/facets)
* If the customer is a member of the specified [Customer Group](/user-guide/customers#customer-groups)

Vendure allows completely custom conditions to be defined by your developers, implementing the specific logic needed by your business.

Expand All @@ -26,9 +26,9 @@ Vendure allows completely custom conditions to be defined by your developers, im
A coupon code can be any text which will activate a Promotion. A coupon code can be used in conjunction with conditions if desired.


{{< alert "primary" >}}
:::note
Note: Promotions **must** have either a **coupon code** _or_ **at least 1 condition** defined.
{{< /alert >}}
:::

## Promotion Actions

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/user-guide/settings/countries-zones.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ title: "Countries & Zones"

By default, Vendure includes all countries in the list, but you are free to remove or disable any that you don't need.

**Zones** provide a way to group countries. Zones are used mainly for defining [tax rates]({{< relref "/user-guide/settings/taxes" >}}) and can also be used in shipping calculations.
**Zones** provide a way to group countries. Zones are used mainly for defining [tax rates](/user-guide/settings/taxes) and can also be used in shipping calculations.

4 changes: 2 additions & 2 deletions docs/docs/user-guide/settings/global-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ The global settings allow you to define certain configurations that affect _all_

* **Available languages** defines which languages you wish to make available for translations. When more than one language has been enabled, you will see the language switcher appear when viewing translatable objects such as products, collections, facets and shipping methods.
![./screen-translations.webp](./screen-translations.webp)
* **Global out-of-stock threshold** sets the stock level at which a product variant is considered to be out of stock. Using a negative value enables backorder support. This setting can be overridden by individual product variants (see the [tracking inventory]({{< relref "/user-guide/catalog/products" >}}#tracking-inventory) guide).
* **Track inventory by default** sets whether stock levels should be tracked. This setting can be overridden by individual product variants (see the [tracking inventory]({{< relref "/user-guide/catalog/products" >}}#tracking-inventory) guide).
* **Global out-of-stock threshold** sets the stock level at which a product variant is considered to be out of stock. Using a negative value enables backorder support. This setting can be overridden by individual product variants (see the [tracking inventory](/user-guide/catalog/products#tracking-inventory) guide).
* **Track inventory by default** sets whether stock levels should be tracked. This setting can be overridden by individual product variants (see the [tracking inventory](/user-guide/catalog/products#tracking-inventory) guide).
2 changes: 1 addition & 1 deletion docs/docs/user-guide/settings/taxes.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ Tax rates set the rate of tax for a given **tax category** destined for a partic

## Tax Compliance

Please note that tax compliance is a complex topic that varies significantly between countries. Vendure does not (and cannot) offer a complete out-of-the-box tax solution which is guaranteed to be compliant with your use-case. What we strive to do is to provide a very flexible set of tools that your developers can use to tailor tax calculations exactly to your needs. These are covered in the [Developer's guide to taxes]({{< relref "/guides/developer-guide/taxes" >}}).
Please note that tax compliance is a complex topic that varies significantly between countries. Vendure does not (and cannot) offer a complete out-of-the-box tax solution which is guaranteed to be compliant with your use-case. What we strive to do is to provide a very flexible set of tools that your developers can use to tailor tax calculations exactly to your needs. These are covered in the [Developer's guide to taxes](/guides/core-concepts/taxes/).
10 changes: 7 additions & 3 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,7 @@ const config = {
keywords: ['cli'],
extendDefaults: true,
},
exclude: [
'user-guide/**/*'
]
// exclude: ['user-guide/**/*'],
},
blog: false,
theme: {
Expand Down Expand Up @@ -92,6 +90,12 @@ const config = {
position: 'left',
label: 'Reference',
},
{
type: 'docSidebar',
sidebarId: 'userGuideSidebar',
position: 'left',
label: 'User Guide',
},
{
href: 'https://vendure.io',
label: 'vendure.io',
Expand Down
32 changes: 32 additions & 0 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,38 @@ const sidebars = {
},
},
],
userGuideSidebar: [
{
type: 'doc',
id: 'user-guide/index',
className: 'reference-index',
},
{
type: 'category',
label: 'Catalog',
items: [{ type: 'autogenerated', dirName: 'user-guide/catalog' }],
},
{
type: 'category',
label: 'Orders',
items: [{ type: 'autogenerated', dirName: 'user-guide/orders' }],
},
{
type: 'category',
label: 'Customers',
items: [{ type: 'autogenerated', dirName: 'user-guide/customers' }],
},
{
type: 'category',
label: 'Promotions',
items: [{ type: 'autogenerated', dirName: 'user-guide/promotions' }],
},
{
type: 'category',
label: 'Settings',
items: [{ type: 'autogenerated', dirName: 'user-guide/settings' }],
},
],
};

module.exports = sidebars;

0 comments on commit 2f2248c

Please sign in to comment.