Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Documentation edits made through Mintlify web editor

mintlify[bot]8289574ca7a5
diff --git a/docs/mint.json b/docs/mint.json
index 7ba6596997..507f3ee596 100644
--- a/docs/mint.json
+++ b/docs/mint.json
@@ -43,12 +43,12 @@
"url": "api-reference"
},
{
- "name": "User Guides",
+ "name": "User Docs",
"url": "user"
}
],
"primaryTab": {
- "name": "Developer Guides"
+ "name": "Developer Docs"
},
"anchors": [
{
diff --git a/docs/user/products/creating-products.mdx b/docs/user/products/creating-products.mdx
index b415c06c18..19b20b76e3 100644
--- a/docs/user/products/creating-products.mdx
+++ b/docs/user/products/creating-products.mdx
@@ -3,7 +3,7 @@ description: "How to Create a Product in Spree Commerce open-source eCommerce pl
title: "Create a Product"
---
-In this article, you will learn how to create a new product, categorize it, and make it active on the storefront.
+In this article, you will learn how to create a new product, categorize it, and make it active on the storefront running on Spree Commerce open-source eCommerce platform.
If your using Spree Enterprise Edition and have hundreds or thousands of products to upload, then it may be more convenient to do it in bulk by using our CSV importer. To learn more about product imports, please refer to this support article: \{\{LINK TO PRODUCT IMPORTS}}
@@ -17,18 +17,12 @@ IMG
This will open the product editor where you can begin creating a new product.
-
-
IMG
## Add a Name & Description
-
-
First of all, enter a name for the product and preferably a description to help customers learn more about the product.
-
-
IMG
### Name
@@ -39,8 +33,6 @@ Here you can set the product title. This name will be displayed on product listi
Here is where you can add the product description. This description will be displayed on product detail pages, and in search engine listings and social sharing links if a meta description has not been set.
-
-
The editor allows you to format the description with standard formatting options like bold, italic, lists, headings, images, etc.
## Media
@@ -49,36 +41,24 @@ This is where you can add visual media to the product.
IMG
-
-
Simply click on the + icon and select the file(s) you’d like to upload.
IMG
Once added, you can rearrange the images by clicking on the 6 dots in the top right corner of an image and dragging and dropping, with the left-most image being the main image that’s displayed on PLPs, and the order of the remaining images affecting the order in which they are presented on the PDP.
-
-
IMG
-
-
If you’d like to remove an image, then you can either check the box in the upper left corner and click Delete Selected, or click on the image itself, click Delete, and then click Save.
-
-
IMG
-
-
The alternative text for an image can be modified by clicking on the image, adding the text, and then clicking Save.
## Status
Here you can manage the availability of the product.
-
-
IMG
### Status
@@ -95,87 +75,58 @@ This indicates whether or not the product is available for purchase on the store
This allows you to set a date on which the product will automatically become Active. 
-
-
Simply set the date and time in the calendar or enter it manually.
-
-
If the product is already set to Active, this option will be hidden.
### Available On
This allows you to set the date on which the product will be released. For example, you can set a future date to indicate that the product is on pre-order.
-
-
Simply set the date and time in the calendar or enter it manually.
### Discontinue On
This allows you to set a date on which the product will automatically be removed from you site, meaning that it will be set to Draft.
-
-
Simply set the date and time in the calendar or enter it manually.
## Categorization
Product catalog categorization is a vital part of running any ecommerce business, unless you only have a few products. The larger your catalog, the more important it is to thoroughly categorize as it makes product discovery much easier for the end user.
-
-
IMG
### Taxonomies
This is where you can assign categories, collections, brands, or any other taxons to the product.
-
-
By adding the product to a taxon, it will be discoverable wherever that taxon is presented, e.g., a featured taxon section on the homepage or that taxon’s PLP.
-
-
Clicking on the dropdown will display a list of all created taxons to select from or you can narrow the results by typing the name partially or fully.
-
-
IMG
-
In the dropdown, taxons are displayed with reference to their position in the taxonomy to avoid confusion with similarly named taxons, e.g., ‘Fashion -> Women -> Shoes’, ‘Fashion -> Men -> Shoes’.
-
-
Simply select which taxons you’d like to assign to the product - there’s no limit to the number of the taxons that can be assigned.
-
-
IMG
-
-
To learn how to assign or remove taxons in bulk, please refer to this support article: \{LINK TO BULK OPERATIONS}
-
-
To learn more about creating taxonomies, please refer to this support article: \{LINK TO TAXONOMIES}
### Tags
Product tags are useful for slicing your products into, for example, eco-friendly, vegan, womenswear. Later, you may filter products by tag during merchandising, use it for displaying related products on the storefront, or automatically creating Collections (in the Enterprise Edition). 
-
-
IMG
## Searching Engine Listing
Here you can modify the SEO elements of the product. Simply click Edit to open the user interface and modify the fields as necessary.
-
-
IMG
### Meta Title
@@ -194,20 +145,14 @@ Changing this affects the URL of the product page. If not set, the product name
This is where you add the price to the new product.
-
-
IMG
### Currency
If your store supports multiple currencies, you’ll be able to set the price for each currency separately.
-
-
IMG
-
-
To learn more about multi-currency, please refer to this support article: 
### Amount
@@ -218,32 +163,22 @@ Set the price of the product here. This is the amount that will be displayed on
If an item is marked down, you can enter it’s old price in here to show customers how it compares to the new price. This will add a crossed out Compare At Amount and a Sale icon to the product wherever it appears on the storefront.
-
-
IMG
## Inventory
This where you can set the stock quantity and other important inventory settings.
-
-
IMG
-
-
If you have multiple stock locations, you’ll be able to set the inventory level for each location separately.
-
-
IMG
### Track Quantity
Checking this box enables the tracking of stock levels for this particular product, meaning you’ll need to add a positive non-zero quantity if you want customers to be able to purchase it (unless it’s backorderable).
-
-
Leaving this box unchecked means that stock levels will not be tracked, and you will not be required to enter a stock quantity. For example, you might not track quantity if your selling digital or made-to-order products.
### Quantity
@@ -256,8 +191,6 @@ Note: When items are sold, the quantity sold will be automatically deducted from
An SKU is an alphanumeric code used to keep track of stock levels internally and for general inventory management purposes. It’s not mandatory to add SKUs, but if you do, each product and variant should have a unique SKU.
-
-
It’s up to you to decide which convention to follow for defining SKUs, but you could use them to convey information about the products, e.g., SKUs containing SS24 are from the Summer/Spring ‘24 collection.
### Barcode (ISBN, UPC, GTIN, etc.)
@@ -270,12 +203,8 @@ You might want to use a barcode if you sell products through multiple channels,
Here is where you can define the different options available for a new product, such as size and color. 
-
-
IMG
-
-
To add variants to a new products:
1. Click “Add options like size or color”
@@ -288,18 +217,12 @@ To add variants to a new products:
5. Repeat steps 1., 2., 3., and 4., if you like to add another Option Type
-
-
IMG
-
-
When clicking Done, you’ll notice the UI changes to combine Pricing and Inventory for each variant, allowing you to set the price and quantity for each separately.
IMG
-
-
If you’d like to learn how to add more Option Types, refer to this support article: \{\{LINK TO OPTIONS ARTICLE}}.
Pro Tip: Make sure that the Option Values are consistent across all products. For example, don’t set sizes as Small, Medium, Large for one product, and S, M, L for another.
@@ -326,17 +249,12 @@ To learn more about shipping categories, please refer to this article: \{\{LINK
Product properties are displayed on the product details page and can convey additional information about the products, such as the material, care instructions, allergens, eco-friendly, etc.
-
-
IMG
Simply fill in the fields with the correct values.
-
To add more Properties, please refer to this support article: \{\{LINK TO PROPERTIES ARTICLE}}
-
-
## Create Product
Now that you’ve added all the necessary product information, make sure to click the blue Create button at the bottom of the product editor, otherwise you may lose all of your progress.
@@ -347,6 +265,4 @@ IMG
If you’re running a marketplace with Spree Enterprise Edition, then you don’t need to worry about creating products because your vendors will be adding them when they onboard.
-
-
However, you can still edit some of the product information as outlined in this article: \{\{LINK TO EDITING PRODUCTS}}
\ No newline at end of file
diff --git a/docs/user/user-quickstart-guide.mdx b/docs/user/user-quickstart-guide.mdx
index eb02e643b9..9f9e0dec31 100644
--- a/docs/user/user-quickstart-guide.mdx
+++ b/docs/user/user-quickstart-guide.mdx
@@ -1,9 +1,9 @@
---
title: "User quickstart"
-description: "Start selling with Spree Commerce open-source eCommerce solution with this user quickstart"
+description: "Start selling with Spree Commerce open-source eCommerce solution"
---
-When first logging in, you’ll be greeted with the Getting Started tab which, by default, outlines 4 onboarding tasks you’ll need to complete.
+When first logging in to your instance of Spree Commerce [open-source eCommerce platform](https://spreecommerce.org/), you’ll be greeted with the Getting Started tab which, by default, outlines 4 onboarding tasks you’ll need to complete.
<img alt="Getting started with Spree Commerce - an Open Source e-commerce platform" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.1_Getting_Started_pwvjhm" />
@@ -33,7 +33,7 @@ Simply follow the steps outlined for that payment method, click Create, and the
<img alt="Payment Method Added" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Getting%20Started/1.4_Getting_Started_-_Payment_Method_Added_eojwfj.png" />
-To learn more about Payment Methods, please refer to this support article: \{\{LINK TO PAYMENTS}}
+To learn more about Payment Methods, please refer to a separate support article.
## Add products
@@ -43,11 +43,11 @@ Next on the list is adding products.
There are three ways to add products to your store:
-1. Adding products manually: \{\{LINK TO CREATING PRODUCTS}}
+1. Adding products manually
-2. Importing products with CSV: \{\{LINK TO PRODUCT IMPORTS}}
+2. Importing products with CSV
-3. Inviting vendors (3rd party products): \{\{LINK TO VENDOR ONBOARDING}}
+3. Inviting vendors (3rd party products)
Please refer to the respective articles for more information on each method of adding products.
@@ -71,7 +71,7 @@ The last task to complete in the Getting Started is setting up taxes collection.
Follow the link in the description and you’ll be redirected to the Tax section of Settings.
-To learn more about setting up taxes, please refer to this support article: \{\{LINK TO TAXES}}
+To learn more about setting up taxes, please refer to a separate support article.
## Shipping Methods
@@ -87,7 +87,7 @@ To add a new shipping method, click the blue button in the top right corner. Thi
Here you can configure the settings of the shipping method, such as the shipping zones, calculator and costs, and estimated delivery time.
-For more information about shipping methods, please refer to this support article: \{\{LINK TO SHIPPING METHODS}}
+For more information about shipping methods, please refer to a separate support article.
## Basic Storefront Setup
@@ -95,7 +95,7 @@ Now that you’ve configured payments, taxes, and shipping, and added some produ
Spree comes with a drag and drop page builder with pre-built page sections that allows you to quickly and easily configure a storefront. This is a great option for MVPs or other projects that don’t require a lot of custom frontend features.
-If you’re planning on using Spree in headless mode and connect it to a separate storefront application, please refer to our developer documentation: \{\{LINK TO RELEVANT DOC}}
+If you’re planning on using Spree in headless mode and connect it to a separate storefront application, please refer to [Spree developer documentation](https://spreecommerce.org/docs/developer/getting-started/quickstart).
The Storefront tab of the admin dashboard, found under Channels & Apps, contains four sections that manage various parts of your storefront.
@@ -129,7 +129,7 @@ To edit the store’s default Theme, simply click on it or click the three dots
This will open the visual page builder UI that allows you to easily add or modify page sections, upload visual media, and change color schemes and fonts.
-<img alt="Drag & Drop Visual Page Builder Composer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327026/docs/Getting%20Started/1.15_Getting_Started_-_Page_Builder_c63a2a.png" />
+<img alt="Drag &amp; Drop Visual Page Builder Composer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327026/docs/Getting%20Started/1.15_Getting_Started_-_Page_Builder_c63a2a.png" />
Themes are mobily-reponsive, and you can switch between views by clicking on the mobile or desktop icons in the top right corner.
@@ -139,9 +139,9 @@ Important: Whenever you make changes to the storefront, it’s important to publ
You can also preview changes you’ve made to the storefront without publishing them by clicking Preview in the top right corne.
-For a comprehensive guide to using the page builder, please refer to this support article: \{\{LINK TO PAGE BUILDER}}
+For a comprehensive guide to using the page builder, please refer to a separate support article.
-### Pages
+### Pages
This where you can add static pages to your store, such as About Us, Contact Us, landing pages, etc.
@@ -197,7 +197,7 @@ This is where you can configure some important settings for the storefront, such
Important: If you want your store to be shown in search engines, make sure to uncheck the box next to “Do not show in search engines” in the SEO section of the settings.
-To learn more about Storefront Settings, please refer to this support article: \{\{LINK TO STOREFRONT SETTINGS}}
+To learn more about Storefront Settings, please refer to a separate support article.
### New Store
@@ -209,7 +209,7 @@ The popup that appears will ask you to give the new store a name, select the cou
<img alt="Configure New Store Settings" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327029/docs/Getting%20Started/1.28_Getting_Started_-_Configure_New_Store_Settings_p7mwlb.png" />
-To learn more about the multi-store feature, please refer to this support article: \{\{LINK TO MULTI-STORE}}
+To learn more about the multi-store feature, please refer to a separate support article.
## Home Screen