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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Cleanup documentation around storefronts (#14133)
Damian Legawiec3160a1ea5efd
diff --git a/docs/.mintlify/Assistant.md b/docs/.mintlify/Assistant.mdindex 9ff70914b7..a334ac19b2 100644--- a/docs/.mintlify/Assistant.md+++ b/docs/.mintlify/Assistant.md@@ -1,3 +1,5 @@## Product context- Store API v3 is the current stable release. Storefront API v2 is deprecated. DO NOT recommend using Storefront API v2 endpoints. ALWAYS look for Store API v3 endpoints first when recommending API endpoints for storefront use cases.- Admin API v3 is the current stable release. Platform API v2 is deprecated. DO NOT recommend using Platform API v2 endpoints. ALWAYS look for Admin API v3 endpoints first when recommending API endpoints for admin use cases.+- Spree is headless platform. In the past there were some tightly coupled frontend gems, but they are deprecated and should not be used or recommended. Always recommend using Store API v3 for storefront development.+- NEVER recommend using `spree_storefront` or `spree_frontend` gems - ALWAYS recommend using Next.js storefront or custom storefront built on top of Store API v3.diff --git a/docs/developer/admin/admin.mdx b/docs/developer/admin/admin.mdxindex 21eba019d9..e776e79b4e 100644--- a/docs/developer/admin/admin.mdx+++ b/docs/developer/admin/admin.mdx@@ -18,7 +18,6 @@ The Admin Dashboard allows store administrators to manage:- **Orders** - Process orders, refunds, and shipments- **Customers** - View customer accounts and order history- **Promotions** - Create discounts, coupon codes, and special offers-- **Content** - Manage pages, menus, and blog posts- **Settings** - Configure store settings, shipping, taxes, and payments## Customization Optionsdiff --git a/docs/developer/admin/extending-ui.mdx b/docs/developer/admin/extending-ui.mdxindex 9148d16653..00a1f40442 100644--- a/docs/developer/admin/extending-ui.mdx+++ b/docs/developer/admin/extending-ui.mdx@@ -858,81 +858,6 @@ Here's a list of all places you can inject your custom code:</Accordion></AccordionGroup>-### Post Categories--<AccordionGroup>- <Accordion title="Post Categories Actions">- `post_categories_actions`-- Injects code into the page actions area for the post categories list page.-- ```erb- <%= link_to "Reorder Categories", reorder_post_categories_path, class: "btn btn-secondary" %>- ```- </Accordion>-- <Accordion title="Post Categories Header">- `post_categories_header`-- Injects code between the page header and the main content area for the post categories list page.-- ```erb- <div class="alert alert-info">- <strong>Organization:</strong> Use categories to organize your blog posts.- </div>- ```- </Accordion>-</AccordionGroup>--### Posts--<AccordionGroup>- <Accordion title="Posts Actions">- `posts_actions`-- Injects code into the page actions area for the posts list page.-- ```erb- <%= link_to "Schedule Posts", schedule_posts_path, class: "btn btn-secondary" %>- ```- </Accordion>-- <Accordion title="Posts Header">- `posts_header`-- Injects code between the page header and the main content area for the posts list page.-- ```erb- <div class="alert alert-info">- <strong>Publishing:</strong> Posts can be scheduled for future publication.- </div>- ```- </Accordion>-- <Accordion title="Posts Filters">- `posts_filters`-- #### Variables-- <ParamField path="f" type="Spree::Admin::FormBuilder">- The [Spree::Admin::FormBuilder](/developer/admin/form-builder) object.- </ParamField>-- Injects code into the posts list filters.-- ```erb- <%= f.spree_select :published_eq,- [["Published", true], ["Draft", false]],- { include_blank: true, label: "Publication Status" },- { data: { filters_target: :input } } %>- ```-- <Tip>- Use [ransack](/developer/core-concepts/search-filtering) search syntax for filter field names.- </Tip>- </Accordion>-</AccordionGroup>-### Promotions<AccordionGroup>@@ -1421,32 +1346,6 @@ Here's a list of all places you can inject your custom code:</Accordion></AccordionGroup>-### Themes--<AccordionGroup>- <Accordion title="Themes Actions">- `themes_actions`-- Injects code into the page actions area for the themes list page.-- ```erb- <%= link_to "Preview All", preview_all_themes_path, class: "btn btn-secondary" %>- ```- </Accordion>-- <Accordion title="Themes Header">- `themes_header`-- Injects code between the page header and the main content area for the themes list page.-- ```erb- <div class="alert alert-info">- <strong>Customization:</strong> Themes control the visual appearance of your storefront.- </div>- ```- </Accordion>-</AccordionGroup>-### Webhooks Subscribers<AccordionGroup>diff --git a/docs/developer/admin/tables.mdx b/docs/developer/admin/tables.mdxindex f6a7804ed2..239262df9e 100644--- a/docs/developer/admin/tables.mdx+++ b/docs/developer/admin/tables.mdx@@ -510,8 +510,6 @@ Spree registers tables for all built-in resources:| `:metafield_definitions` | `Spree::MetafieldDefinition` || `:gift_cards` | `Spree::GiftCard` || `:stock_items` | `Spree::StockItem` |-| `:posts` | `Spree::Post` |-| `:post_categories` | `Spree::PostCategory` || `:webhook_endpoints` | `Spree::WebhookEndpoint` || `:webhook_deliveries` | `Spree::WebhookDelivery` || `:price_list_products` | `Spree::Product` (nested) |diff --git a/docs/developer/contributing/updating-extensions.mdx b/docs/developer/contributing/updating-extensions.mdxdeleted file mode 100644index df3e8f5711..0000000000--- a/docs/developer/contributing/updating-extensions.mdx+++ /dev/null@@ -1,68 +0,0 @@-----title: Updating Extensions-description: How to upgrade your Spree extension to work with Spree 4-version: v4------## Zeitwerk compatibility--Zeitwerk is the [new default code autoloader in Rails 6](https://weblog.rubyonrails.org/2019/2/22/zeitwerk-integration-in-rails-6-beta-2/).--This doesn't work well with the old approach to decorators files that name ends with decorator.rb, eg. `app/models/spree/order_decorator.rb` using [class_eval](https://www.jimmycuadra.com/posts/metaprogramming-ruby-class-eval-and-instance-eval/).--To fix this we need to convert all `class_eval` decorators to modules and use [Module.prepend](https://medium.com/@leo_hetsch/ruby-modules-include-vs-prepend-vs-extend-f09837a5b073). Also we need to name them properly according to [Zeitwerk naming rules](https://github.com/fxn/zeitwerk#file-structure)--Example of an old decorator:--```ruby app/models/spree/order_decorator.rb-Spree::Order.class_eval do- has_many :new_custom_model-- def some_method- # ...- end-end-```--the same decorator in the new notation:--```ruby app/models/your_extension_name/order_decorator.rb-module YourExtensionName::OrderDecorator- def self.prepended(base)- base.has_many :new_custom_model- end-- def some_method- # ...- end-end--Spree::Order.prepend(YourExtensionName::OrderDecorator)-```--## Fixing Deface Overrides--Please remember to prepare versioned overrides for both Spree 3.x and 4.x, eg. [https://github.com/spree-contrib/spree_static_content/commit/e4b9e4900024235158d0ec1a48a100b4732348ef](https://github.com/spree-contrib/spree_static_content/commit/e4b9e4900024235158d0ec1a48a100b4732348ef)--Spree 4 uses Bootstrap 4 and many partials and HTML structure changed compared to Spree 3.x.--Also - **remember to add deface gem to gemspec** as deface itself was removed as a dependency of Spree. eg. [https://github.com/spree/spree_auth_devise/commit/d729689ca87d8586e541ffcc865ef1e0a5a79fe4](https://github.com/spree/spree_auth_devise/commit/d729689ca87d8586e541ffcc865ef1e0a5a79fe4)--## Migrate to Spree Dev Tools--Replace all development dependencies with:--```ruby-s.add_development_dependency 'spree_dev_tools'-```--Replace `spec_helper.rb` contents with:--[https://github.com/spree/spree/blob/777a284b4c70e69d32a05ffa61bbe3905d8f1297/cmd/lib/spree_cmd/templates/extension/spec/spec_helper.rb](https://github.com/spree/spree/blob/777a284b4c70e69d32a05ffa61bbe3905d8f1297/cmd/lib/spree_cmd/templates/extension/spec/spec_helper.rb)--Example migrations:--* [https://github.com/spree/spree_gateway/pull/357](https://github.com/spree/spree_gateway/pull/357)-* [https://github.com/spree-contrib/spree-product-assembly/pull/200](https://github.com/spree-contrib/spree-product-assembly/pull/200)-* [https://github.com/spree/spree_auth_devise/pull/487](https://github.com/spree/spree_auth_devise/pull/487)-diff --git a/docs/developer/core-concepts/slugs.mdx b/docs/developer/core-concepts/slugs.mdxindex 407d928f02..a85390b2d3 100644--- a/docs/developer/core-concepts/slugs.mdx+++ b/docs/developer/core-concepts/slugs.mdx@@ -75,7 +75,7 @@ When a slug changes (e.g., a product is renamed), Spree preserves the old slug.## Internationalization-Products, categories, and posts support localized slugs — a different slug per locale:+Products and categories support localized slugs — a different slug per locale:<CodeGroup>diff --git a/docs/developer/customization/v4/admin-panel.mdx b/docs/developer/customization/v4/admin-panel.mdxdeleted file mode 100644index 11d287d3d2..0000000000--- a/docs/developer/customization/v4/admin-panel.mdx+++ /dev/null@@ -1,82 +0,0 @@-<Warning>- This section is only relevant for Spree 4-</Warning>--Starting with Spree 4.7, we've introduced a new way of customizing the admin panel, that enables extensions to modify the admin panel UI without depending on the Deface gem. For Spree 4.6 and earlier, please see how to use [deface_overrides_tutorial.md](../advanced/deface_overrides_tutorial.md "mention") overrides.--### Customizing the main menu--When extending Spree with custom features, it's common to add new options to the menu on the left-hand side.--The menu is built with [`Spree::Admin::MainMenu::Section`](https://github.com/spree/spree_backend/blob/main/app/models/spree/admin/main_menu/section.rb) and [`Spree::Admin::MainMenu::Item`](https://github.com/spree/spree_backend/blob/main/app/models/spree/admin/main_menu/item.rb) objects.--Additionally, there are two builder classes [`Spree::Admin::MainMenu::SectionBuilder`](https://github.com/spree/spree_backend/blob/main/app/models/spree/admin/main_menu/section_builder.rb) and [`Spree::Admin::MainMenu::ItemBuilder`](https://github.com/spree/spree_backend/blob/main/app/models/spree/admin/main_menu/item_builder.rb) that make it easier to build more complex sections.--The menu is available under `Rails.application.config.spree_backend.main_menu` and can be modified by both extensions as well as the Rails application code.--#### Example: adding an additional section to the admin panel:--```ruby-Rails.application.config.after_initialize do- Rails.application.config.spree_backend.main_menu.add(- Spree::Admin::MainMenu::SectionBuilder.new('subscriptions', 'inbox-fill.svg').- with_admin_ability_check(Spree::Subscription).- with_items(- Spree::Admin::MainMenu::ItemBuilder.new('active', Spree::Core::Engine.routes.url_helpers.admin_active_subsciptions_path).build,- Spree::Admin::MainMenu::ItemBuilder.new('expired', Spree::Core::Engine.routes.url_helpers.admin_expired_subsciptions_path).build- ).- build- )-end-```--For a more extensive example, take a look at how the [default menu is built](https://github.com/spree/spree_backend/blob/main/app/models/spree/admin/main_menu/default_configuration_builder.rb).--### Customizing tabs--In some cases you may need to add a new tab to a page for editing Orders, Products or Users.----These tabs are built with [`Spree::Admin::Tabs::Tab`](https://github.com/spree/spree_backend/blob/main/app/models/spree/admin/tabs/tab.rb). You can also use [`Spree::Admin::Tabs::TabBuilder`](https://github.com/spree/spree_backend/blob/main/app/models/spree/admin/tabs/tab_builder.rb) class to construct new Tab objects. The tabs are attached to `Rails.application.config.spree_backend.tabs` and can be modified via an initializer.--#### Example: adding an additional tab to the product edit admin page--```ruby-Rails.application.config.after_initialize do- Rails.application.config.spree_backend.tabs[:product].add(- Spree::Admin::Tabs::TabBuilder.new('discounts', ->(resource) { admin_product_discounts_path(product) }).- with_icon_key('view.svg').- with_active_check.- build- )-end-```--### Customizing actions--A common case for extensions is to add a new action button in the admin panel.--Action buttons are built with [`Spree::Admin::Actions::Action`](https://github.com/spree/spree_backend/blob/main/app/models/spree/admin/actions/action.rb) or with a dedicated [`Spree::Admin::Actions::ActionBuilder`](https://github.com/spree/spree_backend/blob/main/app/models/spree/admin/actions/action_builder.rb) class. The action buttons are attached to `Rails.application.config.spree_backend.actions` and can be modified with an initializer.--**Example: adding a new button to the order page**--```ruby-Rails.application.config.after_initialize do- Rails.application.config.spree_backend.actions[:order].add(- Spree::Admin::Actions::ActionBuilder.new('generate_export', admin_export_orders_path).- with_icon_key('list.svg').- with_style(Spree::Admin::Actions::ActionStyle::PRIMARY).- with_method(:post).- build- )-end-```--### Customizing existing views and partials--If you need a more extensive customization of any of the admin panel pages, you can just copy their .erb file from the `spree_backend` gem to your `app/views/` directory and modify it there. This allows you to fully override default views provided by the `spree_backend` gem.--<Note>- Note: This approach is not recommended for Spree extensions, as it may conflict with other extensions that modify the same view.-</Note>\ No newline at end of filediff --git a/docs/developer/customization/v4/authentication.mdx b/docs/developer/customization/v4/authentication.mdxdeleted file mode 100644index 9132df84be..0000000000--- a/docs/developer/customization/v4/authentication.mdx+++ /dev/null@@ -1,196 +0,0 @@-----title: Authentication-description: Learn how to use a custom authentication setup with Spree-version: v4------This guide covers using a custom authentication setup with Spree, such as one provided by your own application. This is ideal in situations where you want to handle the sign-in or sign-up flow of your application uniquely, outside the realms of what would be possible with Spree or you have an existing authentication with user accounts present.--This guide assumes that you have a pre-existing model inside your application that represents the users of your application already. This model could be provided by gems such as [Devise](https://github.com/plataformatec/devise). This guide also assumes that the application that this `User` model exists in is already a Spree application.--<Note>-This model **does not** need to be called `User`, but for the purposes of this guide the model we will be referring to **will** be called `User`. If your model is called something else, do some mental substitution wherever you see `User`.-</Note>--To use your own authentication system with Spree, please follow these steps:--<AccordionGroup>- <Accordion title="1. Change the Spree.user_class">- To begin using your custom `User` class, you must first edit Spree's initializer located at `config/initializers/spree.rb` by changing this line:-- ```ruby- Spree.user_class = 'Spree::User'- ```-- To this:-- ```ruby- Spree.user_class = 'User'- ```- </Accordion>-- <Accordion title="2. Update User model">- Next, you need to run the custom user generator for Spree which will create a migration that will add the necessary Spree fields to your users table.-- Run this generator with this command:-- ```bash- bin/rails g spree:custom_user User- ```-- This will tell the generator that you want to use the `User` class as the class that represents users in Spree. Run the new migration by running this:-- ```bash- bin/rails db:migrate- ```-- This generator will also create a file at `lib/spree/current_user_helpers.rb` which will be automatically included in your application's controllers allowing you to override the `spree_current_user` method to return the current user of the request.- </Accordion>- <Accordion title="3. Include User concerns in your User model">- In your User Model please include the following lines:-- ```ruby- include Spree::UserMethods- include Spree::UserAddress- include Spree::UserPaymentSource- ```-- The first of these methods are the ones added for the `has_and_belongs_to_many` association called `spree_roles`. This association will retrieve all the roles that a user has for Spree.-- The second of these is the `spree_orders` association. This will return all orders associated with the user in Spree. There's also a `last_incomplete_spree_order` method which will return the last incomplete spree order for the user. This is used internal to Spree to persist order data across a user's login sessions.-- The third and fourth associations are for address information for a user. When a user places an order, the address information for that order will be linked to that user so that it is available for subsequent orders.-- The next method is one called `has_spree_role?` which can be used to check if a user has a specific role. This method is used internally to Spree to check if the user is authorized to perform specific actions, such as accessing the admin section. Admin users of your system should be assigned the Spree admin role, like this:-- ```ruby- user = User.find_by(email: '[email protected]')- user.spree_roles << Spree::Role.where(name: 'admin').first_or_create- ```-- To test that this has worked, use the `has_spree_role?` method, like this:-- ```ruby- user.has_spree_role?('admin')- ```-- If this returns `true`, then the user has admin permissions within Spree.- </Accordion>- <Accordion title="4. Customize Spree Authentication Helpers (Optional)">- <Note>- This step is required if you're using **`spree_backend`** and/or `spree_frontend` gems.- </Note>-- Run a generator to create a file at `lib/spree/authentication_helpers.rb` which will contain the following code to help you do that:-- ```bash- bin/rails g spree:custom_authentication- ```-- This will create a file at `lib/spree/authentication_helpers.rb` which will contain the following code to help you do that:-- ```ruby- module Spree- module AuthenticationHelpers- def self.included(receiver)- receiver.helper_method(- :spree_current_user,- :spree_login_path,- :spree_signup_path,- :spree_logout_path,- :spree_forgot_password_path,- :spree_edit_password_path,- :spree_admin_login_path,- :spree_admin_logout_path,- )- end-- def spree_current_user- current_user- end-- def spree_login_path(opts = {})- main_app.login_path(opts)- end-- def spree_signup_path(opts = {})- main_app.signup_path(opts)- end-- def spree_logout_path(opts = {})- main_app.logout_path(opts)- end-- def spree_forgot_password_path(opts = {})- main_app.forgot_password_path(opts)- end-- def spree_edit_password_path(opts = {})- main_app.edit_password_path(opts)- end-- def spree_admin_login_path(opts = {})- main_app.admin_login_path(opts)- end-- def spree_admin_logout_path(opts = {})- main_app.admin_logout_path(opts)- end- end- end- ```-- Each of the methods defined in this module return values that are the most common in Rails applications today, but you may need to customize them. In order, they are:-- * `spree_current_user` Used to tell Spree what the current user of a request is.- * `spree_login_path` The location of the login/sign in form in your application.- * `spree_signup_path` The location of the sign up form in your application.- * `spree_logout_path` The location of the logout feature of your application.- * `spree_forgot_password_path` The location to reset a user's password.- * `spree_edit_password_path` The location to edit a user's password.- * `spree_admin_login_path` The location of the login/sign in form for the admin panel.- * `spree_admin_logout_path` The location of the logout feature for the admin panel.-- URLs inside the helpers **must** have `main_app` prefixed if they are inside your application. This is because Spree will otherwise attempt to route these paths to the Spree engine, which does not exist. By prefixing with `main_app`, you tell it to look at the application's routes.-- You will need to define the `login_path`, `signup_path` and `logout_path` routes yourself, by using code like this inside your application's `config/routes.rb` if you're using Devise:-- ```ruby- devise_for :users- devise_scope :user do- get '/login', to: "devise/sessions#new"- get '/signup', to: "devise/registrations#new"- delete '/logout', to: "devise/sessions#destroy"- get '/forgot_password', to: "devise/passwords#new"- get '/edit_password', to: "devise/registrations#edit"- end- ```-- Of course, this code will be different if you're not using Devise. Simply **do not** use the `devise_scope` method and change the controllers and actions for these routes.-- You can also customize these methods inside `lib/spree/authentication_helpers.rb` to use the routing helper methods already provided by the authentication setup you have, if you wish.-- Any modifications made to `lib/spree/authentication_helpers.rb` while the server is running will require a restart, as with any other modification to other files in `lib`.- </Accordion>- <Accordion title="5. Remove Auth Devise gem">- The `spree_auth_devise` gem is not needed when using an existing application authentication unless the goal is to have two separate authentication methods.-- You can remove the `spree_auth_devise` gem by running this command:-- ```bash- bundle remove spree_auth_devise- ```- </Accordion>-</AccordionGroup>--## Admin Panel authentication--By default Spree uses the same model for the admin panel as the storefront. However you can customize it to use a different model.--To do this, you need to add the following code to your `config/initializers/spree.rb` file:--```ruby-Spree.admin_user_class = 'AdminUser'-```--This will tell Spree to use the `AdminUser` model for the admin panel. You will need to create this model in your application and ensure that it includes the necessary Spree fields.diff --git a/docs/developer/customization/v4/checkout.mdx b/docs/developer/customization/v4/checkout.mdxdeleted file mode 100644index f11b0b1921..0000000000--- a/docs/developer/customization/v4/checkout.mdx+++ /dev/null@@ -1,214 +0,0 @@-----title: Checkout Flow-description: Learn how to customize the checkout process in Spree.-version: v4------## Overview--The Spree checkout process has been designed for maximum flexibility. It's been redesigned several times now, each iteration has benefited from the feedback of real-world deployment experience. It is relatively simple to customize the checkout process to suit your needs. Secure transmission of customer information is possible via SSL and credit card information is never stored in the database.--## The Checkout Flow DSL--Spree comes with a new checkout DSL that allows you to succinctly define the different steps of your checkout. This new DSL allows you to customize _just_ the checkout flow, while maintaining the unrelated admin states, such as "canceled" and "resumed", that an order can transition to. Ultimately, it provides a shorter syntax compared with overriding the entire state machine for the `Spree::Order` class.--The default checkout flow for Spree is defined like this, adequately demonstrating the abilities of this new system:--```ruby-checkout_flow do- go_to_state :address- go_to_state :delivery- go_to_state :payment, if: ->(order) {- order.update_totals- order.payment_required?- }- go_to_state :confirm, if: ->(order) { order.confirmation_required? }- go_to_state :complete- remove_transition from: :delivery, to: :confirm-```--we can pass a block on each checkout step definition and work some logic to figure if the step is required dynamically. e.g. the confirm step might only be necessary for payment gateways that support payment profiles.--These conditional states present a situation where an order could transition from delivery to one of payment, confirm or complete. In the default checkout, we never want to transition from delivery to confirm, and therefore have removed it using the `remove_transition` method of the Checkout DSL. The resulting transitions between states look like the image below:--These two helper methods are provided on `Spree::Order` instances for your convenience:--* `checkout_steps` - returns a list of all the potential states of the checkout.-* `has_step?` - Used to check if the current order fulfills the requirements for a specific state.--If you want a list of all the currently available states for the checkout, use the `checkout_steps` method, which will return the steps in an array.--## Default Checkout Steps--The Spree checkout process consists of the following steps. With the exception of the Registration step, each of these steps corresponds to a state of the [Order object](/developer/core-concepts/orders):--* Registration Optional - only if using [spree_auth_devise](https://github.com/spree/spree_auth_devise) extension, can be toggled through the `Spree::Auth::Config[:registration_step]` configuration setting-* Address Information-* Delivery Options Shipping Method-* Payment-* Confirmation--The following sections will provide a walk-through of checkout from a user's perspective, and offer some information on how to configure the default behavior of the various steps.--### Registration--<Info>-This section only applies when using `spree_frontend` and `spree_auth_devise` gems.-</Info>--Prior to beginning the checkout process, the customer will be prompted to create a new account or to log in to their existing account. By default, there is also a "guest checkout" option that allows users to specify only their email address if they do not wish to create an account.--Technically, the registration step is not an actual state in the `Spree::Order` state machine. The `spree_auth_devise` gem (an extension that comes with Spree Starter by default) adds the `check_registration` before filter to all actions of `Spree::CheckoutController` except for obvious reasons the `registration` and `update_registration` actions, which redirects to a registration page unless one of the following is true:--* `Spree::Auth::Config[:registration_step]` preference is not `true`-* user is already logged in-* the current order has an email address associated with it--The method is defined like this:--```ruby-def check_registration- return unless Spree::Auth::Config[:registration_step]- return if spree_current_user || current_order.email- store_location- redirect_to spree.checkout_registration_path-end-```--#### Disabling guest checkout--To completely disable guest checkout and require registration for checkout, you need to change Spree configuration in `config/initializers/spree.rb`:--```ruby-Spree::Config[:allow_guest_checkout] = false-```--### Address Information--This step allows the customer to add both their billing and shipping information. Customers can click the "use billing address" option to use the same address for both.--The address fields include a select box for choosing state/province. If there are no states configured for a particular country, the select box will be replaced by a text field instead.--The list of countries that appear in the country select box can also be configured. Spree will list all countries by default, but you can configure exactly which countries you would like to appear. The list can be limited to a specific set of countries by [setting the Store's checkout zone](/developer/core-concepts/stores#checkout-configuration). Spree assumes that the list of billing and shipping countries will be the same. You can always change this logic via class decorator if this does not suit your needs.--### Delivery Options--During this step, the user may choose a delivery method. Spree assumes the list of shipping methods to be dependent on the shipping address.--### Payment--This step is where the customer provides payment information. This step is intentionally placed last in order to minimize security issues with credit card information. Credit card information is never stored in the database so it would be impossible to have a subsequent step and still be able to submit the information to the payment gateway. Spree submits the information to the gateway before saving the model so that the sensitive information can be discarded before saving the checkout information.--Spree stores only the last four digits of the credit card number along with the expiration information. The full credit card number and verification code are never stored in the Spree database.--Several gateways such as ActiveMerchant and Beanstream provide a secure method for storing a "payment profile" in your database. This approach typically involves the use of a "token" which can be used for subsequent purchases but only with your merchant account. If you are using a secure payment profile it would then be possible to show a final "confirmation" step after payment information is entered.--If you do not want to use a gateway with payment profiles then you will need to customize the checkout process so that your final step submits the credit card information. You can then perform authorization before the order is saved. This is perfectly secure because the credit card information is not ever saved. It's transmitted to the gateway and then discarded like normal.-- Spree discards the credit card number after this step is processed. If you do not have a gateway with payment profiles enabled then your card information will be lost before it's time to authorize the card.--For more information about payments, please see the [Payments guide](/developer/core-concepts/payments).--### Confirmation--This is the final opportunity for the customer to review their order before submitting it to be processed. Users have the opportunity to return to any step in the process using either the back button or by clicking on the appropriate step in the "progress breadcrumb."--This step is disabled by default, but can be enabled by two ways:--1. globally for all orders by setting a preference in `config/initializers/spree.rb`:-- ```ruby- Spree::Config[:always_include_confirm_step] = true- ```--2. conditionally for specific orders by overriding the `confirmation_required?` method in `Spree::Order`, eg.-- ```ruby- module Spree- module OrderDecorator- # require confirmation for orders with a US billing address- def confirmation_required?- billing_address&.country_iso == 'US'- end- end- end- ```--## Adding Logic Before or After a Particular Step--The [state_machines](https://github.com/state-machines/state_machines) gem allows you to implement callbacks before or after transitioning to a particular step. These callbacks work similarly to [Active Record Callbacks](http://guides.rubyonrails.org/active_record_callbacks.html) in that you can specify a method or block of code to be executed prior to or after a transition. If the method executed in a before_transition returns false, then the transition will not execute.--So, for example, if you wanted to verify that the user provides a valid zip code before transitioning to the delivery step, you would first implement a `valid_zip_code?` method, and then tell the state machine to run this method before that transition, placing this code in a file called `app/models/spree/order_decorator.rb`:--```ruby-module Spree- module OrderDecorator- def self.prepended(base)- base.state_machine.before_transition to: :delivery, do: :valid_zip_code?- end-- def valid_zip_code?- # logic to check if the zip code is valid- end- end-- Order.prepend(OrderDecorator)-end-```--This callback would prevent transitioning to the `delivery` step if `valid_zip_code?` returns false.--## Modifying the checkout flow--To add or remove steps to the checkout flow, you can use the-[insert_checkout_step](https://github.com/spree/spree/blob/a39ed2b69f1f2b2f413b7f46090bd0deeb439d61/core/app/models/spree/order/checkout.rb#L138) and [remove_checkout_step](https://github.com/spree/spree/blob/a39ed2b69f1f2b2f413b7f46090bd0deeb439d61/core/app/models/spree/order/checkout.rb#L157) helpers respectively.--The `insert_checkout_step` method takes a `before` or `after` option to determine where to insert the step:--```ruby-module Spree- module OrderDecorator- def self.prepended(base)- base.insert_checkout_step :new_step, before: :address- # or- # base.insert_checkout_step :new_step, after: :address- end- end-- Order.prepend(OrderDecorator)-end-```--The `remove_checkout_step` will remove just one checkout step at a time:--```ruby-module Spree- module OrderDecorator- def self.prepended(base)- base.remove_checkout_step :address- base.remove_checkout_step :delivery- end- end-- Order.prepend(OrderDecorator)-end-```--What will happen here is that when a user goes to checkout, they will be asked to potentially fill in their payment details and then potentially confirm the order. This is the default behavior of the payment and the confirm steps within the checkout. If they are not required to provide payment or confirmation for this order then checking out this order will result in its immediate completion.--To completely re-define the flow of the checkout, use the `checkout_flow` helper:--```ruby-module Spree- module OrderDecorator- def self.prepended(base)- base.checkout_flow do- go_to_state :payment- go_to_state :complete- end- end- end-- Order.prepend(OrderDecorator)-end-```\ No newline at end of filediff --git a/docs/developer/customization/v4/deface.mdx b/docs/developer/customization/v4/deface.mdxdeleted file mode 100644index 83f1cf8b1b..0000000000--- a/docs/developer/customization/v4/deface.mdx+++ /dev/null@@ -1,254 +0,0 @@-----title: Deface Overrides-version: v4------<Warning>-Using Deface is no longer recommended, we strongly encourage you to use other ways to customize Spree.-</Warning>--## What is Deface?--Deface is a standalone Rails library that enables you to customize Erb templates without needing to directly edit the underlying view file. Deface allows you to use standard CSS3 style selectors to target any element including Ruby blocks, and perform an action against all the matching elements.--## Improving Our Extension Using Deface--### The Goal--Our goal is to add a field to the product edit admin page that allows the `sale_price` to be added or updated. We could do this by overriding the view Spree provides, but there are potential problems with this technique. If Spree updates the view in a new release we won't get the updated view as we are already overriding it. We would need to update our view with the new content from Spree and then add our customizations back in to stay fully up to date.--Let's do this instead using Deface, which we just learned about. Using Deface will allow us to keep our view customizations in one spot, `app/overrides`, and make sure we are always using the latest implementation of the view provided by Spree.--### The Implementation--We want to override the product edit admin page, so the view we want to modify in this case is the product form partial. This file's path will be `spree/admin/products/_form.html.erb`.--First, let's create the overrides directory with the following command:--```bash-mkdir app/overrides-```--So we want to override `spree/admin/products/_form.html.erb`. Here is the part of the file we are going to add content to you can also view the [full file](https://github.com/spree/spree/blob/main/backend/app/views/spree/admin/products/_form.html.erb):--```erb-<div class="right four columns omega" data-hook="admin_product_form_right">- <%= f.field_container :price do %>- <%= f.label :price, raw(Spree.t(:master_price) + required_span_tag) %>- <%= f.text_field :price, value: number_to_currency(@product.price, unit: '')%>- <%= f.error_message_on :price %>- <% end %>-</div>-```--We want our override to insert another field container after the price field container. We can do this by creating a new file `app/overrides/add_sale_price_to_product_edit.rb` and adding the following content:--```ruby-Deface::Override.new(virtual_path: 'spree/admin/products/_form',- name: 'add_sale_price_to_product_edit',- insert_after: "erb[loud]:contains('text_field :price')",- text: "- <%%= f.field_container :sale_price do %>- <%%= f.label :sale_price, raw(Spree.t(:sale_price) + content_tag(:span, ' *')) %>- <%%= f.text_field :sale_price, value:- number_to_currency(@product.sale_price, unit: '') %>- <%%= f.error_message_on :sale_price %>- <%% end %>- ")-```--We also need to delegate `sale_price` to the master variant in order to get the updated product edit form working.--We can do this by creating a new file `app/models/spree/product_decorator.rb` and adding the following content to it:--```ruby-module Spree- Product.class_eval do- delegate :sale_price, :sale_price=, to: :master- end-end-```--Now, when we head to `http://localhost:3000/admin/products` and edit a product, we should be able to set a sale price for the product and be able to view it on our sale page, `http://localhost:3000/sale`. Note that you will likely need to restart our example Spree application created in the [Getting Started tutorial](/developer/getting-started/quickstart).--### Available actions--Deface applies an **action** to elements matching the supplied CSS selector. These actions are passed when defining a new override are supplied as the key while the CSS selector for the target elements is the value, for example:--```ruby-remove: "p.junk"--insert_after: "div#wow p.header"--insert_bottom: "ul#giant-list"-```--Deface currently supports the following actions:--* :remove - Removes all elements that match the supplied selector-* :replace - Replaces all elements that match the supplied selector, with the content supplied-* :replace_contents - Replaces the contents of all elements that match the supplied selector-* :surround - Surrounds all elements that match the supplied selector, expects replacement markup to contain <%%= render_original %> placeholder-* :surround_contents - Surrounds the contents of all elements that match the supplied selector, expects replacement markup to contain <%%= render_original %> placeholder-* :insert_after - Inserts after all elements that match the supplied selector-* :insert_before - Inserts before all elements that match the supplied selector-* :insert_top - Inserts inside all elements that match the supplied selector, as the first child-* :insert_bottom - Inserts inside all elements that match the supplied selector, as the last child-* :set_attributes - Sets attributes on all elements that match the supplied selector, replacing existing attribute value if present or adding if not. Expects :attributes option to be passed.-* :add_to_attributes - Appends value to attributes on all elements that match the supplied selector, adds attribute if not present. Expects :attributes option to be passed.-* :remove_from_attributes - Removes value from attributes on all elements that match the supplied selector. Expects :attributes option to be passed.-- Not all actions are applicable to all elements. For example, \`:insert_top\` and \`:insert_bottom\` expects a parent element with children.--### Supplying content--Deface supports three options for supplying content to be used by an override:--* :text - String containing markup-* :partial - Relative path to a partial-* :template - Relative path to a template-- As Deface operates on the Erb source the content supplied to an override can include Erb, it is not limited to just HTML. You also have access to all variables accessible in the original Erb context.--### Targeting elements--While Deface allows you to use a large subset of CSS3 style selectors as provided by Nokogiri, the majority of Spree's views have been updated to include a custom HTML attribute data-hook, which is designed to provide consistent targets for your overrides to use.--As Spree views are changed over coming versions, the original HTML elements maybe edited or be removed. We will endeavour to ensure that data-hook / id combination will remain consistent within any single view file where possible, thus making your overrides more robust and upgrade proof.--For example, spree/products/show.html.erb looks as follows:--```erb-<div data-hook="product_show" itemscope itemtype="http://schema.org/Product">- <%% body_id = 'product-details' %>- <div class="columns six alpha" data-hook="product_left_part">- <div class="row" data-hook="product_left_part_wrap">- <div id="product-images" data-hook="product_images">- <div id="main-image" data-hook>- <%%= render 'image' %>- </div>-- <div id="thumbnails" data-hook>- <%%= render 'thumbnails', product: product %>- </div>- </div>-- <div data-hook="product_properties">- <%%= render 'properties' %>- </div>-- </div>- </div>-- <div class="columns ten omega" data-hook="product_right_part">- <div class="row" data-hook="product_right_part_wrap">-- <div id="product-description" data-hook="product_description">-- <h1 class="product-title" itemprop="name"><%%= accurate_title %></h1>-- <div itemprop="description" data-hook="description">- <%%= product_description(product) rescue Spree.t(:product_has_no_description) %>- </div>-- <div id="cart-form" data-hook="cart_form">- <%%= render 'cart_form' %>- </div>- </div>-- <%%= render 'taxons' %>- </div>- </div>-</div>-```--As you can see from the example above the `data-hook` can be present in a number of ways:--* On elements with **no** `id` attribute the `data-hook` attribute-- contains a value similar to what would be included in the `id`-- attribute.--* On elements with an `id` attribute the `data-hook` attribute does-- **not** normally contain a value.--* Occasionally on elements with an `id` attribute the `data-hook` will-- contain a value different from the elements id. This is generally to-- support migration from the old 0.60.x style of hooks, where the old-- hook names were converted into `data-hook` versions.--The suggested way to target an element is to use the `data-hook` attribute wherever possible. Here are a few examples based on **products/show.html.erb** above:--```ruby-replace: "[data-hook='product_show']"--insert_top: "#thumbnails[data-hook]"--remove: "[data-hook='cart_form']"-```--You can also use a combination of both styles of selectors in a single override to ensure maximum protection against changes:--```ruby- insert_top: "[data-hook='thumbnails'], #thumbnails[data-hook]"-```--### Targeting ruby blocks--Deface evaluates all the selectors passed against the original erb view contents and importantly not against the finished / generated HTML. In order for Deface to make ruby blocks contained in a view parseable they are converted into a pseudo markup as follows.--Given the following Erb file:--```erb-<%% if products.empty? %>- <%%= Spree.t(:no_products_found) %>-<%% elsif params.key?(:keywords) %>- <h3><%%= Spree.t(:products) %></h3>-<%% end %>-```--Would be seen by Deface as:--```markup-<!-- <html>- <erb[silent]> if products.empty? </erb>- <erb[loud]> Spree.t(:no_products_found) </erb>- <erb[silent]> elsif params.key?(:keywords) </erb>-- <h3><erb[loud]> Spree.t(:products) </erb></h3>-- <erb[silent]> end </erb>-</html> -->-```--So you can target ruby code blocks with the same standard CSS3 style selectors, for example:--```ruby-replace: "erb[loud]:contains('t(:products)')"--insert_before: "erb[silent]:contains('elsif')"-```--### View upgrade protection--To ensure upgrading between versions of Spree is as painless as possible, Deface supports an `:original` option that can contain a string of the original content that's being replaced. When Deface is applying the override it will ensure that the current source matches the value supplied and will output to the Rails application log if they are different.--These warnings are a good indicator that you need to review the source and ensure your replacement is adequately replacing all the functionality provided by Spree. This will help reduce unexpected issues after upgrades.--Once you've reviewed the new source you can update the `:original` value to new source to clear the warning.-- Deface removes all whitespace from both the actual and \`:original\` source values before comparing, to reduce false warnings caused by basic whitespace differences.--### Organizing Overrides--The suggested method for organizing your overrides is to create a separate file for each override inside the **app/overrides** directory, naming each file the same as the **:name** specified within.--### More information on Deface--For more information and sample overrides please refer to its [README](https://github.com/spree/deface) file on GitHub.-diff --git a/docs/developer/customization/v4/images.mdx b/docs/developer/customization/v4/images.mdxdeleted file mode 100644index 7f672acfda..0000000000--- a/docs/developer/customization/v4/images.mdx+++ /dev/null@@ -1,86 +0,0 @@-----title: Images-version: v4------## Overview--This guide explains how to change Product Images dimensions and different storage options for [ActiveStorage](https://edgeguides.rubyonrails.org/active_storage_overview.html) which is the default attachment storage system in Spree.---## Dimensions--To change the default image dimensions or add new ones you need to create a decorator file:--```bash-mkdir -p app/models/spree && touch app/models/spree/image_decorator.rb-```--with the following content:--```ruby-module Spree- module ImageDecorator- module ClassMethods- def styles- {- # change existing default sizes used in Admin Panel and API- mini: '48x48>',- small: '100x100>',- product: '240x240>',- large: '600x600>',- # add your new size here, which will be automatically available in the API- my_custom_size: '1000x1000>'- }- end- end-- def self.prepended(base)- base.inheritance_column = nil- base.singleton_class.prepend ClassMethods- end- end-- Image.prepend(ImageDecorator)-end-```--## Using image variations in templates--You can also create [image variations on the fly in your templates](https://guides.rubyonrails.org/active_storage_overview.html), eg.--```erb-<%= image_tag(main_app.url_for(@product.images.first.attachment.variant(resize: '150x150'))) %>-```--## Storage service--By default Spree will use the storage service you have set in your environment file eg. `config/environments/development.rb`:--```ruby-config.active_storage.service = :amazon-```--If you have multiple storage services you can customize which storage service to use for images. This is done in the `config/initializers/spree.rb`:--```ruby-Spree.public_storage_service_name = :amazon-```--The storage name needs to match the name you configured in `config/storage.yml`.--## Using CDNs--To use a CDN service such as AWS Cloudfront or Cloudflare, you need to set `Spree.cdn_host` to the hostname of your CDN service. This is done in the `config/initializers/spree.rb`:--```ruby-Spree.cdn_host = 'https://mycloudfrontserviceid.cloudfront.net'-```--Spree will handle the rest as we have a built-in reverse proxy for ActiveStorage.--To use CDN in your templates please use `cdn_image_url` helper:--```erb-<%= main_app.cdn_image_url(@product.images.first.attachment.variant(resize: '150x150')) %>-```diff --git a/docs/developer/customization/v4/storefront.mdx b/docs/developer/customization/v4/storefront.mdxdeleted file mode 100644index 5566508e69..0000000000--- a/docs/developer/customization/v4/storefront.mdx+++ /dev/null@@ -1,452 +0,0 @@-<Note>-This section covers the Rails storefront which was extracted to [`spree_frontend`](https://github.com/spree/spree_rails_frontend) ruby gem.-</Note>--## Styling with SASS variables--Spree 4 under the hood uses [Bootstrap 4](https://getbootstrap.com/docs/4.6/getting-started/theming/) for easy theming with some additional Spree-specific [SASS variables](https://sass-lang.com/documentation/variables).--To make those changes live you need to update SCSS variable files located in your project at `app/assets/stylesheets/spree/frontend/variables/variables.scss`.--### Header--_**$header-background**_ - header background color variable with 2 examples: white and blue one. By default, this is set with a _**$primary-background**_ value but you can replace it with any other value in the variables.scss file.--_**$header-font-color**_- Header font color. By default set with _**$font-color**_ value but you can replace it with any other value in the variables.scss file.--### Footer--_**$footer-background**_ - a variable that overrides $primary-background and allows you to change the footer color. See a white and a blue example below.--_**$footer-font-color**_ - a variable that overrides _**$font-color**_ and allows you to change the footer font color. See black and blue font examples below.--### Meganav menu--_**$meganav-background**_ - a variable that allows you to change the mega nav menu background color. By default the meganav menu is set to a _**$primary-background**_ value but you can replace it with any other value in the variables.scss file.--_**$meganav-font-color**_ - a font color variable in the mega nav menu. By default the mega nav font color is set to a $font-color value but you can replace it with any other value in the variables.scss file.--### Background--_**$primary-background**_ - the main background color across the whole site. There are two examples below, of the white and the black backgrounds. Please note that you can also use an image as a background.--_**$secondary-background**_ - the second background color present across the whole site with examples attached below.--_**$font-color**_ - this variable affects all fonts on the $primary-background. Please see two examples below.--_**$secondary-font-color**_ - this affects all fonts on $secondary-background. By default, it is set with a $font-color value but you can replace it with any other value in the variables.scss file.--### Border color--_**$global-border-style**_ - this affects the border and separator color throughout the whole site--### Fonts--_**$font-family**_ - this sets the font family used across your site. By default, it is in Sans Serif but you can replace it with any other value in the variables.scss file. Check out [these font families](https://websitesetup.org/web-safe-fonts-html-css/) you might use.--### Input fields--_**$input-background**_ - this allows you to set a color for all input field backgrounds across the site. See two examples of a white and a yellow backround below.--_**$second-global-border**_ - this allows you to set a color for all input field borders across the whole site. See an example below with red input field borders.--### Primary color--#### Home page--_**$primary-color**_ variable changes--* The color of the **SHOP NOW** button on the main hero image-* The color of the **Summer 2019** text and **READ MORE** button-* The color of the **NEW COLLECTION** and **SUMMER SALE** headers inside the categories section--#### Search results--_**$primary-color**_ variable changes--* The color of the **No results** icon--#### Mega Menu--_**$primary-color**_ variable changes--* The color of **NEW COLLECTION** and **SUMMER SALE** headers inside the banners--#### PDP--_**$primary-color**_ variable changes--* The color of the **IN STOCK** text-* The color of the **ADD TO CART** button--#### Cart Page--_**$primary-color**_ variable changes--* The color of the **Trash** delete icon for removing items from the cart-* The color of the **CHECKOUT** button--#### Cart pop-up--_**$primary-color**_ variable changes--* The color of the **CHECKOUT** and **VIEW CART** buttons--#### Cart - empty--_**$primary-color**_ variable changes--* The color of the **CONTINUE SHOPPING** button-* The color of the **Empty cart** icon--#### Checkout - Registration Step--_**$primary-color**_ variable changes--* The color of the **LOG IN, SIGN UP** and **CONTINUE AS A GUEST** buttons--#### Checkout - Address step--_**$primary-color**_ variable changes--* The color of the **SAVE AND CONTINUE** button (this element remains the same across the whole checkout process)-* The color of the **Edit** icon--#### Checkout - Payment step--_**$primary-color**_ variable changes--* The color of the **APPLY** button--#### Checkout - Confirm step--_**$primary-color**_ variable changes--* The color of the **PLACE ORDER** button--#### Sign-in page--_**$primary-color**_ variable changes--The color of the **LOG IN** and **SIGN UP** buttons--#### Sign up page--_**$primary-color**_ variable changes--* The color of the **SIGN UP** and **LOG IN** buttons--#### My account page--_**$primary-color**_ variable changes--* The color of the **Edit** and **Trash** icons--#### Edit account page--_**$primary-color**_ variable changes--* The color of the **UPDATE** button--#### Pop-ups--_**$primary-color**_ variable changes--* The color of the **CANCEL** and **OK** buttons--### Secondary color--#### PLP--_**$secondary-color**_ variable changes--* The color of the chosen **color** border variant-* The color of the chosen **size** border variant-* The color of the chosen **length** border variant-* The color of the chosen **price** border variant--#### PDP--_**$secondary-color**_ variable changes--* The color of the chosen **color** border variant-* The color of the chosen **size** border variant-* The color of the chosen **length** border variant-* The color of the chosen **image** border--#### Pop-ups--_**$secondary-color**_ variable changes--* The color of the **Add to bag successfully** icon--Log-in and Sign-in page--_**$secondary-color**_ variable changes--* The color of the **Remember me** checkbox-* The color of the **input: focus**--#### Checkout--_**$secondary-color**_ variable changes--* The color of **individual steps** (box, name step, and guideline) - this element remains the same across the whole checkout process--#### Checkout - Address step--_**$secondary-color**_ variable changes--* The color of the **Use shipping address** checkbox--#### Checkout - Delivery step--_**$secondary-color**_ variable changes--* The color of delivery type radio buttons--#### Checkout - Payment step--_**$secondary-color**_ variable changes--* The color of payment type radio buttons-* The color of payment card radio buttons--#### Order confirmation page--_**$secondary-color**_ variable changes--* The color of the **successful checkmark** icon--### Grid breakpoints--[Grid breakpoint variable](https://github.com/spree/spree/blob/main/frontend/app/assets/stylesheets/spree/frontend/variables/bootstrap-overrides.scss) allows you to slightly change element sizes on various devices. These changes are mostly to images and their scale ratio. Feel free to learn more from the [Bootstrap manual](https://getbootstrap.com/docs/4.0/layout/grid/), though we don’t recommend changing these values unless you really need to.--### Rounding for components--_**$enable-rounded**_ - Enable rounding for components.--Possible values: **true** or **false**--**“True” example**--**“False” example**--### Shadows for components--_**$enable-shadows**_ - Enable shadow for components--Possible values: **true** or **false**--### Gradient for components--_**$enable-gradients**_ - Enable gradient for components--_**$enable-gradients**_ - Enable gradient for components--## Templates--### Importing--You can import all templates from spree frontend into your application using this command (in your application root directory):--```bash-rails g spree:frontend:copy_storefront-```--All of those views will be added to your `app/views` directory under `spree` folder. You can modify them as you wish.--## Assets--### Spree's Asset Pipeline--Spree applications include an `app/assets` directory. We've taken this one step further by subdividing each top level asset directory (images, JavaScript files, stylesheets) into `frontend` and `backend` directories. This is designed to keep assets from the frontend and backend from conflicting with each other.--A typical assets directory for a Spree application will look like:--```-app-|-- assets- |-- images- | |-- spree- | |-- frontend- | |-- backend- |-- javascripts- | |-- spree- | |-- frontend- | | |-- all.js- | |-- backend- | |-- all.js- |-- stylesheets- | |-- spree- | |-- frontend- | | |-- all.css- | |-- backend- | |-- all.css-```--Spree also generates four top level manifests (all.css & all.js, see above) that require all the core extension's and site specific stylesheets / JavaScript files.--### How core extensions (engines) manage assets--All core engines have been updated to provide four asset manifests that are responsible for bundling up all the JavaScript files and stylesheets required for that engine.--For example, Spree provides the following manifests:--```-vendor-|-- assets- |-- javascripts- | |-- spree- | |-- frontend- | | |-- all.js- | |-- backend- | |-- all.js- |-- stylesheets- | |-- spree- | |-- frontend- | | |-- all.css- | |-- backend- | |-- all.css-```--These manifests are included by default by the relevant all.css or all.js in the host Spree application. For example, `vendor/assets/javascripts/spree/backend/all.js` includes:--```javascript-//= require spree/backend--//= require_tree .-```--External JavaScript libraries, stylesheets and images have also been relocated into vendor/assets.--### Managing your application's assets--Assets that customize your Spree store should go inside the appropriate directories inside `vendor/assets/images/spree`, `vendor/assets/javascripts/spree`, or `vendor/assets/stylesheets/spree`. This is done so that these assets do not interfere with other parts of your application.--### Overriding Spree's assets--Overriding or replacing any of Spree's internal assets is even easier than before. It's recommended to attempt to replace as little as possible in a given JavaScript or stylesheet file to help ease future upgrade work required.--The methods listed below will work for both applications, extensions and themes with one noticeable difference: Extension & theme asset files will not be automatically included (see above for instructions on how to include asset files from your extensions / themes).--### Overriding individual CSS styles--Say for example you want to replace the following CSS snippet:--```css-/* spree/app/assets/stylesheets/spree/frontend/screen.css */--div#footer {- clear: both;-}-```--You can now just create a new stylesheet inside `your_app/vendor/assets/stylesheets/spree/frontend/` and include the following CSS:--```css-/* vendor/assets/stylesheets/spree/frontend/foo.css */--div#footer {- clear: none;- border: 1px solid red;-}-```--The `frontend/all.css` manifest will automatically include `foo.css` and it will actually include both definitions with the one from `foo.css` being included last, hence it will be the rule applied.--### Overriding entire CSS files--To replace an entire stylesheet as provided by Spree you simply need to create a file with the same name and save it to the corresponding path within your application's or extension's `vendor/assets/stylesheets` directory.--For example, to replace `spree/frontend/all.css` you would save the replacement to `your_app/vendor/assets/stylesheets/spree/frontend/all.css`.--This same method can also be used to override stylesheets provided by third-party extensions.--### Overriding individual JavaScript functions--A similar approach can be used for JavaScript functions. For example, if you wanted to override the `show_variant_images` method:--```javascript- // spree/app/assets/javascripts/spree/frontend/product.js--var show_variant_images = function(variant_id) {- $('li.vtmb').hide();- $('li.vtmb-' + variant_id).show();- var currentThumb = $('#' +- $("#main-image").data('selectedThumbId'));-- // if currently selected thumb does not belong to current variant,- // nor to common images,- // hide it and select the first available thumb instead.-- if(!currentThumb.hasClass('vtmb-' + variant_id) &&- !currentThumb.hasClass('tmb-all')) {- var thumb = $($('ul.thumbnails li:visible').eq(0));- var newImg = thumb.find('a').attr('href');- $('ul.thumbnails li').removeClass('selected');- thumb.addClass('selected');- $('#main-image img').attr('src', newImg);- $("#main-image").data('selectedThumb', newImg);- $("#main-image").data('selectedThumbId', thumb.attr('id'));- }-}-```--Again, just create a new JavaScript file inside `your_app/vendor/assets/javascripts/spree/frontend` and include the new method definition:--```javascript- // your_app/vendor/assets/javascripts/spree/frontend/foo.js--var show_variant_images = function(variant_id) {- alert('hello world');-}-```--The resulting `frontend/all.js` would include both methods, with the latter being the one executed on request.--### Overriding entire JavaScript files--To replace an entire JavaScript file as provided by Spree you simply need to create a file with the same name and save it to the corresponding path within your application's or extension's `app/assets/javascripts` directory.--For example, to replace `spree/frontend/all.js` you would save the replacement to `your_app/vendor/assets/javascripts/spree/frontend/all.js`.--This same method can be used to override JavaScript files provided by third-party extensions.--## SEO recommendations--### Sitemap--We highly recommend adding a sitemap to your site. It might affect how Google bot crawls your store pages. There is an official extension called [Spree Sitemap](https://github.com/spree-contrib/spree_sitemap) for that exact purpose.--1. Per region, language or currency-2. Click the **Edit** button (indicated with a pencil icon) for the right store-3. Enter a title, keywords, and description values for the store homepage-4. Click the **Update** button at the bottom of the page--To set the title, meta keywords, and description for each store **category page (PLP)**, in the admin panel:--1. Go to **Products > Taxonomies**-2. Go into the Categories list by pressing the **Edit** button (pencil icon)-3. Pick the category you’d like to edit by right-clicking (control + click on a Mac) a child in the tree to access the menu for adding, deleting or sorting a child.-4. Click the **Edit** link for that category-5. Replace the default values for title, meta keywords, and description with your own-6. Click the **Update** button at the bottom of the page--You’ll have to edit every category and subcategory to your liking in a similar fashion.--To set the title, meta keywords and description for each **product page (PDP)**, in the admin panel:--1. Go to **Products > Products**-2. In the product list pick the right one by pressing the **Edit** button (pencil icon)-3. While in the Details tab, scroll down and input your values for the title, meta keywords, and description-4. Click the **Update** button at the bottom of the page--### Social sharing and search preview--The new Spree UX has the following social sharing features implemented:--* Facebook sharing with [Open Graph tags](https://ogp.me/) to enable an attractive page preview-* Google visibility with structured data using [Schema.org](http://schema.org/) with [JSON-DL](https://json-ld.org/)--Feel free to [test the Open Graph tags implementation](https://developers.facebook.com/tools/debug/) and the also [test the Schema.org implementation](https://search.google.com/structured-data/testing-tool/u/0/) for your store.diff --git a/docs/developer/storefront/rails/sections.mdx b/docs/developer/storefront/rails/sections.mdxindex d9aff0a8c9..d0cfea77cf 100644--- a/docs/developer/storefront/rails/sections.mdx+++ b/docs/developer/storefront/rails/sections.mdx@@ -581,4 +581,4 @@ Here's a complete example putting it all together - a "Brand Story" section:<% end %>```</Step>-</Steps>\ No newline at end of file+</Steps>diff --git a/docs/developer/storefront/rails/storefront.mdx b/docs/developer/storefront/rails/storefront.mdxindex 1a91f9e3fa..8f9356ba97 100644--- a/docs/developer/storefront/rails/storefront.mdx+++ b/docs/developer/storefront/rails/storefront.mdx@@ -3,6 +3,10 @@ title: "Rails Storefront Overview"sidebarTitle: "Overview"---+<Warning>+ We recommend using [Next.js Storefront](/developer/storefront/nextjs) for new projects, as it offers better performance and a more modern developer experience.+</Warning>+Rails Storefront is a mobile-first storefront that is fully customizable & themeable.### Tech Stackdiff --git a/docs/developer/storefront/rails/themes.mdx b/docs/developer/storefront/rails/themes.mdxindex 7fc7812b71..636dbc9beb 100644--- a/docs/developer/storefront/rails/themes.mdx+++ b/docs/developer/storefront/rails/themes.mdx@@ -4,6 +4,10 @@ sidebarTitle: "Themes"description: "Learn how to develop themes for your Spree storefront"---+<Warning>+ We recommend using [Next.js Storefront](/developer/storefront/nextjs) for new projects, as it offers better performance and a more modern developer experience.+</Warning>+Themes are the main building blocks of the storefront. They hold styles, settings, and templates for the storefront.## Default Themediff --git a/docs/docs.json b/docs/docs.jsonindex ef92508415..3b40507751 100644--- a/docs/docs.json+++ b/docs/docs.json@@ -114,6 +114,10 @@{"source": "/developer/storefront/custom-javascript","destination": "/developer/storefront/rails/custom-javascript"+ },+ {+ "source": "/api-reference/introduction",+ "destination": "/api-reference"}],"contextual": {@@ -802,14 +806,6 @@"use-case/digital-products/admin-capabilities"]},- {- "group": "Multi-Store Platform",- "pages": [- "use-case/multi-store/model",- "use-case/multi-store/capabilities",- "use-case/multi-store/admin-capabilities"- ]- },{"group": "Multi-Tenant Platform","pages": [diff --git a/docs/use-case/digital-products/capabilities.mdx b/docs/use-case/digital-products/capabilities.mdxindex 88aba5c23f..93deacc17d 100644--- a/docs/use-case/digital-products/capabilities.mdx+++ b/docs/use-case/digital-products/capabilities.mdx@@ -32,18 +32,6 @@ While many digital products features are available out-of-the-box in Spree CommuSpree offers flexibility across all layers of the platform, from code-level customization to no-code configuration.-- **Customization (Custom Code)**- - **Backend (Ruby on Rails)** - extend business logic, workflows, and integrations via Spree's modular architecture. See:[<u>Spree Developer Quickstart</u>](https://spreecommerce.org/docs/developer/getting-started/quickstart)- - **Frontend Themes (HTML, CSS, JS)** - customize storefront layouts, styling, and interactivity to match your brand and UX goals. See:[<u>Storefront Customization</u>](https://spreecommerce.org/docs/developer/storefront/storefront)-- **Configuration (No-Code / Low-Code)**- - **Store Settings** - configure store name, logo, contact details, and supported languages/currencies.- - **Custom Domains & Code Snippets** - set up domains and inject scripts (e.g., Google Tag Manager, Hotjar) without code.- - **Shipping & Tax** - define shipping zones, rates, and tax rules per market.-- **Theme Editor (No-Code / Low-Code)**- - **Drag-and-Drop Editor** - create and rearrange content using pre-built modules.- - **Modular Pages** - build landing pages, homepages, and campaign sections.- - **Brand Asset Management** - upload logos, banners, and product imagery without developer input.-## Full Ownership And ControlWith Spree, you’re not locked into a black-box SaaS model. You retain complete control over your infrastructure, data, and roadmap, enabling long-term flexibility, scalability, and compliance.diff --git a/docs/use-case/marketplace/capabilities.mdx b/docs/use-case/marketplace/capabilities.mdxindex 8385e4826a..2d22a8cb76 100644--- a/docs/use-case/marketplace/capabilities.mdx+++ b/docs/use-case/marketplace/capabilities.mdx@@ -74,18 +74,6 @@ While many marketplace features are available out-of-the-box in Spree EnterpriseSpree Enterprise offers flexibility across all layers of the platform, from code-level customization to no-code configuration.-- **Customization (Custom Code)**- - **Backend (Ruby on Rails)** - extend business logic, workflows, and integrations via Spree's modular architecture. See: [<u>Spree Developer Quickstart</u>](https://spreecommerce.org/docs/developer/getting-started/quickstart)- - **Frontend Themes (HTML, CSS, JS)** - customize storefront layouts, styling, and interactivity to match your brand and UX goals. See: [<u>Storefront Customization</u>](https://spreecommerce.org/docs/developer/storefront/storefront)-- **Configuration (No-Code / Low-Code)**- - **Store Settings** - configure store name, logo, contact details, and supported languages/currencies.- - **Custom Domains & Code Snippets** - set up domains and inject scripts (e.g., Google Tag Manager, Hotjar) without code.- - **Shipping & Tax** - define shipping zones, rates, and tax rules per market.-- **Theme Editor (No-Code / Low-Code)**- - **Drag-and-Drop Editor** - create and rearrange content using pre-built modules.- - **Modular Pages** - build landing pages, homepages, and campaign sections.- - **Brand Asset Management** - upload logos, banners, and product imagery without developer input.-## Full Ownership And ControlWith Spree Enterprise, you’re not locked into a black-box SaaS model. You retain complete control over your infrastructure, data, and roadmap, enabling long-term flexibility, scalability, and compliance.diff --git a/docs/use-case/multi-store/admin-capabilities.mdx b/docs/use-case/multi-store/admin-capabilities.mdxdeleted file mode 100644index 111060a7f2..0000000000--- a/docs/use-case/multi-store/admin-capabilities.mdx+++ /dev/null@@ -1,83 +0,0 @@-----title: "Multi-Store Admin Capabilities"-description: "Learn about the admin features available in Spree Commerce multi-store."------Spree Commerce gives admins the power to manage multiple ecommerce stores from a single unified dashboard, with full control over what’s shared between all stores and what’s store-specific. This flexible configuration allows teams to support region-specific catalogs, niche storefronts, or multi-brand ecosystems, without duplicating infrastructure or fragmenting data.--Here’s how Spree helps businesses rapidly launch, customize, and manage multiple stores from a single dashboard at scale:--## Store Creation & Configuration--- **One-Click Store Setup** - Quickly spin up new storefronts from the admin dashboard.-- **Custom Domains** - Assign unique domains (or subdomains) per store.-- **Theme & Page Isolation** - Each store can have its own look and feel, with independent content pages and themes.-- **Store Settings** - Define store name, default language, currency, logo, favicon, and more.--## Resource Sharing & Isolation--- Control how much each store shares with others:- - **Shared Resources (optional)**:- - Products and product groups (selectively assignable from a central product catalog)- - Inventory locations and stock levels- - Customers and customer segments- - Shipping methods, rates, and markets- - Payment methods and processors- - Admin user access- - **Isolated per Store**:- - Orders, shipments, payments, refunds- - Store credits and gift cards- - Blogs and newsletter settings- - Integrations (e.g., GA4, Meta Pixel)- - CMS pages and custom themes--## Catalog Management--- **Assign Products to Stores** - Manage which products are visible on which stores.-- **Localized Catalogs** - Set up regional assortments with localized pricing, content, and availability.-- **Inventory Management** - Control which stock locations fulfill orders for each store.--## Promotions & Merchandising--- **Store-Specific Discounts** - Run unique sales, coupon codes, and promotions per store.-- **Custom Tax Rules** - Apply regional tax rules at the store level.-- **Curated Collections** - Create manual or automatic product collections tailored to each store’s audience.--## Payment & Checkout Settings--- **Flexible Payment Configuration** - Each store can use different payment gateways or currencies.-- **Saved Payment Methods** - Buyers can reuse cards across stores (if using shared customer accounts).-- **Quick Checkout Options** - Enable Apple Pay, Google Pay, BNPL options per store.-- **Store-Specific Tax Logic** - Real-time tax calculations per region or country.--## Fulfillment & Shipping--- **Shipping Zones & Methods** - Configure store-specific shipping options.-- **Shared Fulfillment Centers** - Assign inventory locations to multiple stores as needed.-- **Carrier Integrations** - Integrate shipping providers per store or globally.--## Admin User Controls--- **Role-Based Access** - Assign different admin roles to manage specific stores.-- **Store Access Permissions** - Control which admin users can view/edit each store’s data.-- **Single Admin Panel** - Manage all stores from one dashboard for efficiency.--## Analytics & Performance--- **Store-Level KPIs** - Track key metrics like revenue, conversion rate, AOV by store.-- **Reports & Exports** - Export store-specific data for orders, products, customers.-- **Analytics Integrations** - Connect each store to its own GA4 or tracking solution.--## Get Started-<Columns cols={2}>- <Card title="Book a Demo" icon="eye" href="https://getvendo.com/book-a-demo/" cta="Click here">- Schedule a demo to explore the platform and get your questions answered- </Card>- <Card title="Ask for Pricing" icon="dollar-sign" href="https://spreecommerce.org/get-started/" cta="Click here">- See Enterprise pricing for your use case- </Card>-</Columns>--## Further Reading-- [<u>Multi-Store Model</u>](https://spreecommerce.org/docs/use-case/multi-store/model)-- [<u>Multi-Store Capabilities</u>](https://spreecommerce.org/docs/use-case/multi-store/capabilities)\ No newline at end of filediff --git a/docs/use-case/multi-store/capabilities.mdx b/docs/use-case/multi-store/capabilities.mdxdeleted file mode 100644index 574fd75179..0000000000--- a/docs/use-case/multi-store/capabilities.mdx+++ /dev/null@@ -1,97 +0,0 @@-----title: "Multi-Store Capabilities"-description: "Learn about the multi-store features available in Spree Commerce."------Spree Commerce Enterprise makes it simple to launch and manage multiple stores from a single backend and admin dashboard, while giving you full control over what’s shared and what’s isolated between them.--Whether you’re running regional storefronts, separate brand identities, or product-specific microsites, Spree’s multi-store architecture ensures operational efficiency, flexible configuration, and a unified customer experience, without the complexity of managing multiple platforms.--## Admin Capabilities--Spree gives store operators the flexibility to manage multiple storefronts from a single admin interface, while defining what should be shared and what remains isolated. Admins can:--- **Easy setup** - provision new stores instantly via the dashboard, each with its own custom domain and branding.-- **Cross-store sharing** - choose what to share between your stores.-- **Store-specific payment gateways** - support localized payment methods or region-specific accounts.-- **Per-store inventory visibility** - allow a product to appear in one store but not another.-- **Admin user permissions** - control access per store or across all stores.-- **Customize themes and pages per store** - allows design freedom within a unified architecture.-- **Store-specific integrations** - connect per-store third party tools like marketing or analytics.-- **Store-specific promotions** - configure promo’s for each store separately.--## Customer Experience--Shoppers can enjoy a seamless and localized experience even across multiple Spree storefronts. Highlights include:--- **Store-specific branding and layout** - maintaining clarity and identity for each regional or brand-based store.-- **Localized content and pricing by store** - including currency, tax logic, and shipping options.-- **Shared customer accounts** - allow shoppers to log in once and access their saved info across stores.-- **Saved payment methods** - users can reuse payment methods across stores, providing a frictionless checkout experience for returning customers.-- **Tailored promotions per store** - supporting unique marketing campaigns or regional offers.-- **Cart isolation** - carts and checkouts are kept separate per store--## Use Case-Specific Customizations--Depending on how the multi-store setup is used, businesses can apply different configurations and custom features:--- **Global vs. Regional Stores** - businesses can share a global product catalog and then localize only what’s needed (e.g., language, prices).-- **Brand Collections** - use multi-store to separate visually and operationally distinct brands while maintaining a shared backend.-- **Regulatory Isolation** - maintain strict separation of tax, privacy, and compliance settings across regions or countries.-- **Promotional Experimentation** - run different marketing strategies per store and compare performance centrally.-- **Content Flexibility** - use store-specific blog content, landing pages, and campaigns for better audience alignment.--## Flexible, Customizable Architecture--While many multi-store features are available out-of-the-box in Spree Enterprise, the open-source foundation means you can extend and tailor the platform to your exact business model - whether that means custom commission logic, ERP integrations, or unique checkout flows.--Spree Enterprise offers flexibility across all layers of the platform, from code-level customization to no-code configuration.--- **Customization (Custom Code)**- - **Backend (Ruby on Rails)** - extend business logic, workflows, and integrations via Spree's modular architecture. See: [<u>Spree Developer Quickstart</u>](https://spreecommerce.org/docs/developer/getting-started/quickstart)- - **Frontend Themes (HTML, CSS, JS)** - customize storefront layouts, styling, and interactivity to match your brand and UX goals. See: [<u>Storefront Customization</u>](https://spreecommerce.org/docs/developer/storefront/storefront)-- **Configuration (No-Code / Low-Code)**- - **Store Settings** - configure store name, logo, contact details, and supported languages/currencies.- - **Custom Domains & Code Snippets** - set up domains and inject scripts (e.g., Google Tag Manager, Hotjar) without code.- - **Shipping & Tax** - define shipping zones, rates, and tax rules per market.-- **Theme Editor (No-Code / Low-Code)**- - **Drag-and-Drop Editor** - create and rearrange content using pre-built modules.- - **Modular Pages** - build landing pages, homepages, and campaign sections.- - **Brand Asset Management** - upload logos, banners, and product imagery without developer input.--## Full Ownership And Control--With Spree Enterprise, you’re not locked into a black-box SaaS model. You retain complete control over your infrastructure, data, and roadmap, enabling long-term flexibility, scalability, and compliance.--- **API-Driven Extensibility**- - **Full API Coverage** - extend the platform via REST APIs for storefronts, checkout, vendor dashboards, or 3rd-party integrations. See: [<u>API Reference</u>](https://spreecommerce.org/docs/api-reference/introduction)- - **Custom Integrations** - seamlessly connect with ERPs, CRMs, payment providers, POS systems, or headless frontends.-- **Deployment Flexibility**- - **Self-Hosting Options** - deploy Spree anywhere; your cloud provider, on-premise, or in specific geographic regions. See: [<u>Deployment Guide</u>](https://spreecommerce.org/docs/developer/deployment/render)- - **Provider Agnostic** - run on AWS, GCP, Azure, or [Render.com](http://Render.com). Tailor infrastructure to budget, compliance, and performance needs.-- **Scalability & Performance**- - **Built for Scale** - Spree supports advanced architectures using load balancers, Redis caching, CDN layers (e.g., Cloudflare or Fastly).- - **High Availability** - avoid downtime during peak sales periods or global rollouts with scalable infrastructure.-- **Security Under Your Control**- - **Data Encryption** - Protect sensitive data in transit and at rest using standard encryption protocols.- - **Anti-DDoS & Rate Limiting** - configure your own network protections using preferred security services.- - **Vulnerability Management** - patch quickly, audit dependencies, and apply security policies with no vendor bottlenecks.-- **Compliance Ownership**- - **Full Compliance Control** - build to meet your exact regulatory requirements, whether WCAG, GDPR, HIPAA, or SOC2.- - **Data Sovereignty** - keep data within borders required by your industry or region.--## Get Started--<Columns cols={2}>- <Card title="Book a Demo" icon="eye" href="https://getvendo.com/book-a-demo/" cta="Click here">- Schedule a demo to explore the platform and get your questions answered- </Card>- <Card title="Ask for Pricing" icon="dollar-sign" href="https://spreecommerce.org/get-started/" cta="Click here">- See Enterprise pricing for your use case- </Card>-</Columns>--## Further Reading--- [<u>Multi-Store Model</u>](https://spreecommerce.org/docs/use-case/multi-store/model)-- [<u>Multi-Store Admin Capabilities</u>](https://spreecommerce.org/docs/use-case/multi-store/admin-capabilities)\ No newline at end of filediff --git a/docs/use-case/multi-store/model.mdx b/docs/use-case/multi-store/model.mdxdeleted file mode 100644index be66b9ba2f..0000000000--- a/docs/use-case/multi-store/model.mdx+++ /dev/null@@ -1,72 +0,0 @@-----title: "Multi-Store Model"-description: "Learn how Spree supports the multi-store ecommerce model."------Spree Commerce Enterprise Edition provides native multi-store functionality, allowing merchants to manage multiple storefronts from a single backend instance and a single admin dashboard to rule them all.--Whether you're targeting different customer segments, operating in multiple regions, or launching sub-brands under the same umbrella, Spree gives you the flexibility to expand without increasing operational overhead.--<Columns cols={2}>- <Card title="Book a Demo" icon="eye" href="https://getvendo.com/book-a-demo/" cta="Click here">- Schedule a demo to explore the platform and get your questions answered- </Card>- <Card title="Ask for Pricing" icon="dollar-sign" href="https://spreecommerce.org/get-started/" cta="Click here">- See Enterprise pricing for your use case- </Card>-</Columns>--## What is Multi-Store Ecommerce?--Multi-store ecommerce allows a business to operate multiple storefronts using a single admin dashboard. Each store may have its own branding, catalog configuration, and domain, while sharing certain operational resources such as inventory, shipping methods, or customer accounts.--In contrast to multi-tenant architecture (where each tenant operates as an independent entity with strict data isolation), multi-store setups are typically used when one business entity manages all stores and wants to centralize backend operations.--## Why Choose a Multi-Store Model?--- **Centralized Operations**: Simplify storemanagement by operating all stores from a single admin panel.-- **Faster Expansion**: Launch new stores in minutes to test new markets, regions, or product lines.-- **Brand Differentiation**: Customize each store's design and domain while keeping operations unified.-- **Shared Resources**: Leverage shared products, inventory, shipping methods, and payment gateways across multiple stores.--## Example Use Cases--- **Multi-Brand Retail**: Operate distinct stores for separate product lines (e.g. fashion vs home goods).-- **International Stores**: Launch region-specific sites like `example.com/us`, `example.com/uk`, each with its own tax and shipping setup.-- **B2B & B2C Separation**: Serve wholesale and retail customers on different storefronts with tailored pricing and content.-- **Niche Sub-Stores**: Use curated storefronts to highlight seasonal campaigns, special collections, or collaborations.--## Challenges and Considerations--- **Data Segmentation**: Deciding what should be shared vs isolated across stores (e.g. products, customers, inventory).-- **Theme Management**: Maintaining consistent branding while allowing design flexibility per store.-- **Localization**: Supporting different currencies, languages, and tax rules per region.-- **Performance Monitoring**: Tracking KPIs and sales across stores from a unified dashboard.--## How Spree Supports Multi-Store--Spree's built-in multi-store functionality makes launching and managing new stores seamless:--- **One-Click Store Setup**: Create a new store in minutes via the admin dashboard.-- **Custom Domains**: Assign each store a unique domain or subdomain.-- **Shared Resource Configuration**:- - **Shared**: Products, Locations & Inventory, Customers, Shipping Methods, Rates, and Markets, Payment Methods, Admin Roles (with per-store access)- - **Not Shared**: Orders, Shipments, Payments, Refunds, Store Credits, Gift Cards, Blogs, Themes, Pages, 3rd-party Integrations-- **Flexible Storefronts**: Each store can have a different theme, layout, and content structure.-- **Per-Store Settings**: Tailor taxes, payment gateways, shipping rules, and currencies for each store independently.--Spree’s multi-store capability is ideal for businesses looking to expand their reach while minimizing complexity. It provides the freedom to differentiate storefronts without duplicating infrastructure - a powerful balance between brand agility and operational efficiency.--## Get Started-<Columns cols={2}>- <Card title="Book a Demo" icon="eye" href="https://getvendo.com/book-a-demo/" cta="Click here">- Schedule a demo to explore the platform and get your questions answered- </Card>- <Card title="Ask for Pricing" icon="dollar-sign" href="https://spreecommerce.org/get-started/" cta="Click here">- See Enterprise pricing for your use case- </Card>-</Columns>--## Further Reading-- [<u>Multi-Store Capabilities</u>](https://spreecommerce.org/docs/use-case/multi-store/capabilities)-- [<u>Multi-Store Admin Capabilities</u>](https://spreecommerce.org/docs/use-case/multi-store/admin-capabilities)diff --git a/docs/use-case/multi-tenant/franchises-and-reseller-networks.mdx b/docs/use-case/multi-tenant/franchises-and-reseller-networks.mdxindex 87ca50b600..de0038c1e5 100644--- a/docs/use-case/multi-tenant/franchises-and-reseller-networks.mdx+++ b/docs/use-case/multi-tenant/franchises-and-reseller-networks.mdx@@ -54,11 +54,9 @@ Manufacturers provide resellers with pre-configured online stores featuring cura- **ERP Integration** - Sync catalog, inventory, and orders with enterprise resource planning systems for streamlined fulfillment.- **Policy Enforcement** - Set global privacy policies, terms, and return policies applied uniformly across all stores.- **Customer Service Control** - Parent company manages customer inquiries, returns, and refunds centrally.-- **Theme Control** - Offer pre-approved storefront themes for franchisees/resellers with limited customization (e.g., logo upload, banner updates).### Reseller/Franchisee Capabilities-- **Storefront Customization** - Choose from pre-set themes and upload brand logos and banners within defined parameters.- **Merchandising Tools** - Curate collections and recommend products from the master catalog.- **Local Promotions** - Create localized promotions and discounts within limits set by the super admin.- **Analytics Dashboard** - View sales performance, customer trends, and commission earnings.@@ -94,4 +92,4 @@ Spree gives the parent business full control over the platform:- [<u>Super Admin Capabilities</u>](https://spreecommerce.org/docs/use-case/multi-tenant/super-admin-capabilities)- [<u>Tenant Capabilities</u>](https://spreecommerce.org/docs/use-case/multi-tenant/tenant-capabilities)- [<u>Multi-Brand Enterprises</u>](https://spreecommerce.org/docs/use-case/multi-tenant/multi-brand-enterprise-model)-- [<u>White-Label SaaS</u>](https://spreecommerce.org/docs/use-case/multi-tenant/white-label-saas)\ No newline at end of file+- [<u>White-Label SaaS</u>](https://spreecommerce.org/docs/use-case/multi-tenant/white-label-saas)diff --git a/docs/use-case/multi-tenant/multi-tenant-capabilities.mdx b/docs/use-case/multi-tenant/multi-tenant-capabilities.mdxindex 0c9085a3d4..c4ac6d4916 100644--- a/docs/use-case/multi-tenant/multi-tenant-capabilities.mdx+++ b/docs/use-case/multi-tenant/multi-tenant-capabilities.mdx@@ -78,18 +78,6 @@ While Spree Enterprise comes with a wide range of features out-of-the-box, the oSpree Enterprise offers flexibility across all layers of the platform, from code-level customization to no-code configuration.-- **Customization (Custom Code)**- - **Backend (Ruby on Rails)** - extend business logic, workflows, and integrations via Spree's modular architecture. See: [<u>Spree Developer Quickstart</u>](https://spreecommerce.org/docs/developer/getting-started/quickstart)- - **Frontend Themes (HTML, CSS, JS)** - customize storefront layouts, styling, and interactivity to match your brand and UX goals. See: [<u>Storefront Customization</u>](https://spreecommerce.org/docs/developer/storefront/storefront)-- **Configuration (No-Code / Low-Code)**- - **Store Settings** - configure store name, logo, contact details, and supported languages/currencies.- - **Custom Domains & Code Snippets** - set up domains and inject scripts (e.g., Google Tag Manager, Hotjar) without code.- - **Shipping & Tax** - define shipping zones, rates, and tax rules per market.-- **Drag & Drop Theme Editor (No-Code / Low-Code)**- - **Drag-and-Drop Editor** - create and rearrange content using pre-built modules.- - **Modular Pages** - build landing pages, homepages, and campaign sections.- - **Brand Asset Management** - upload logos, banners, and product imagery without developer input.-## Full Ownership And ControlWith Spree Enterprise, you’re not locked into a black-box SaaS model. You retain complete control over your infrastructure, data, and roadmap, enabling long-term flexibility, scalability, and compliance.diff --git a/docs/use-case/multi-tenant/multi-tenant-model.mdx b/docs/use-case/multi-tenant/multi-tenant-model.mdxindex a5e518ff7c..32e6e9b41c 100644--- a/docs/use-case/multi-tenant/multi-tenant-model.mdx+++ b/docs/use-case/multi-tenant/multi-tenant-model.mdx@@ -49,7 +49,6 @@ Each tenant is logically isolated - managing their own products, orders, custome## Challenges in Multi-Tenant Commerce- **Data Isolation**: Ensuring tenants cannot access each other’s products, orders, customers, or analytics.-- **Per-Tenant Customization**: Supporting varied storefront themes and branding, payment methods, tax rules, and shipping zones.- **Scalability**: Handling growing traffic and transaction volumes across multiple tenants.- **Security & Compliance**: Meeting strict requirements for data privacy (GDPR, HIPAA) and accessibility (WCAG).@@ -79,4 +78,4 @@ Spree provides a solid foundation for multi-tenant commerce:- [<u>Tenant Capabilities</u>](https://spreecommerce.org/docs/use-case/multi-tenant/tenant-capabilities)- [<u>Franchises & Reseller Networks</u>](https://spreecommerce.org/docs/use-case/multi-tenant/franchises-and-reseller-networks)- [<u>Multi-Brand Enterprises</u>](https://spreecommerce.org/docs/use-case/multi-tenant/multi-brand-enterprise-model)-- [<u>White-Label SaaS</u>](https://spreecommerce.org/docs/use-case/multi-tenant/white-label-saas)\ No newline at end of file+- [<u>White-Label SaaS</u>](https://spreecommerce.org/docs/use-case/multi-tenant/white-label-saas)diff --git a/docs/use-case/multi-tenant/super-admin-capabilities.mdx b/docs/use-case/multi-tenant/super-admin-capabilities.mdxindex c2fd3919c7..bd85c9e28a 100644--- a/docs/use-case/multi-tenant/super-admin-capabilities.mdx+++ b/docs/use-case/multi-tenant/super-admin-capabilities.mdx@@ -62,7 +62,6 @@ Gain insights into tenant performance and platform-wide KPIs.Customize the platform’s appearance for a seamless white-label experience.- **Full Control** - Unified branding across all tenant stores for a consistent look and feel.-- **Full Freedom** - Tenants control their own branding, including themes, colors, and logos.- **Hybrid** - Allow tenant branding within predefined global guidelines.## API Management@@ -113,4 +112,4 @@ Maintain platform-wide security and regulatory standards.- [<u>Tenant Capabilities</u>](https://spreecommerce.org/docs/use-case/multi-tenant/tenant-capabilities)- [<u>Franchises & Reseller Networks</u>](https://spreecommerce.org/docs/use-case/multi-tenant/franchises-and-reseller-networks)- [<u>Multi-Brand Enterprises</u>](https://spreecommerce.org/docs/use-case/multi-tenant/multi-brand-enterprise-model)-- [<u>White-Label SaaS</u>](https://spreecommerce.org/docs/use-case/multi-tenant/white-label-saas)\ No newline at end of file+- [<u>White-Label SaaS</u>](https://spreecommerce.org/docs/use-case/multi-tenant/white-label-saas)diff --git a/docs/use-case/overview.mdx b/docs/use-case/overview.mdxindex 8df5ebeb1e..c0b452d87f 100644--- a/docs/use-case/overview.mdx+++ b/docs/use-case/overview.mdx@@ -17,10 +17,6 @@ Spree Commerce [Enterprise Edition](https://spreecommerce.org/docs/user/what-is-Streamline and automate your B2B ecommerce operations, enhancing customer relationships and sales efficiency.</Card>-<Card title="Multi-Store Platform" icon="people-roof" href="https://spreecommerce.org/docs/use-case/multi-tenant/multi-tenant-capabilities" cta="Learn more">- Run multiple storefronts from a single backend, each with custom domains, catalogs, and configurations, while sharing infrastructure and admin controls.-</Card>-<Card title="ChatGPT Integration" icon="people-roof" href="https://spreecommerce.org/docs/use-case/multi-tenant/multi-tenant-capabilities" cta="Learn more">Convert product discovery into instant sales by enabling checkout directly within ChatGPT conversations using the Agentic Commerce Protocol.</Card>@@ -76,12 +72,6 @@ Learn more about the full list of [multi-vendor marketplace capabilities](https:- Seamless integrations with ERP, CRM, and inventory management systems- Flexible business model expansion through dropshipping and multiple warehouses-#### [Multi-Store Platform](https://spreecommerce.org/docs/use-case/multi-store/capabilities)--- Spin up new storefronts instantly with customizable domains, themes, and configurations-- Share customers, products, and payment methods across stores while isolating orders and content-- Centralize operations with a single admin dashboard controlling multiple stores-#### [ChatGPT Integration](https://spreecommerce.org/docs/use-case/chatgpt-integration/chatgpt-instant-checkout)- Reach intent-driven buyers directly through ChatGPT product recommendations@@ -119,4 +109,4 @@ To join the Spree Community and over 6000+ Spree users and developers, please jo<Card title="Ask for Pricing" icon="dollar-sign" href="https://spreecommerce.org/get-started/" cta="Click here">Ask for Enterprise Edition pricing for the Use Case of your choice.</Card>-</Columns>\ No newline at end of file+</Columns>diff --git a/docs/user/storefront/create-new-store.mdx b/docs/user/storefront/create-new-store.mdxdeleted file mode 100644index a4440c1b11..0000000000--- a/docs/user/storefront/create-new-store.mdx+++ /dev/null@@ -1,76 +0,0 @@-----title: "Create a New Store"-description: "Learn how to create and manage multiple stores in Spree Commerce."------Spree’s [<u>multi-store functionality</u>](https://spreecommerce.org/docs/use-case/multi-store/capabilities) allows you to manage completely separate storefronts - each with its own branding, products, payment methods, and more - all from a single admin dashboard.--This is useful if you want to:-- Target different customer segments or regions-- Operate multiple brands or product lines-- Offer localized shopping experiences--## Add a New Store----1. Click **\+** next to your store name in the top-left corner of the admin dashboard.-2. Select **New Store** from the dropdown.--This opens a panel where you can configure the new store.--### Required Settings----You’ll be asked to fill in the following:-- **Site Name** - the public-facing name of your store (used in social sharing and SEO)-- **Country** - the country this store will serve-- **Default locale** - the default language to be used on the store-- **Currency** - the currency used at checkout-- **Import Products** - whether to import existing products from another store-- **Import Payment Methods** - whether to import payment methods from another store--<Note>Your choices should align with your business strategy. For example, if you're launching in a new region, you might use a different currency or pricing strategy but reuse your product catalog and payment setup.</Note>--Once ready, click **Create** to launch your new store. You’ll be automatically redirected to its admin panel.--## Switch Between Stores-----To manage a different store, click the **store name** in the top-left corner and select the store you want to access.--## Cross-Store Data Sharing--When creating a new store, Spree gives you control over what data is shared and what remains separate.--### Shared with New Store-- **Products, Inventory & Locations** (can choose which apply to this store)-- **Customers**-- **Shipping Methods, Rates, Markets**-- **Payment Methods** (selectable per store)-- **Admin User Access**--### Not Shared with New Store-- Orders-- Shipments-- Payments-- Refunds-- Store Credits-- Gift Cards-- Blog Posts-- Themes & Pages-- Integrations (e.g., Google Analytics, Meta Pixel)--## Next Steps--Once your new store is created, you can:--- [<u>Customize the storefront theme</u>](https://spreecommerce.org/docs/user/storefront/theme-editor)-- [<u>Set up store-specific promotions</u>](https://spreecommerce.org/docs/user/promotions/create-a-promotion)-- [<u>Manage localized shipping and tax settings</u>](https://spreecommerce.org/docs/user/settings/zones)-- [<u>Import or manage your product catalog</u>](https://spreecommerce.org/docs/user/manage-products/import-products)--Interested to learn more? Check out our [<u>Multi-Store use case article</u>](https://spreecommerce.org/docs/use-case/multi-store/model).diff --git a/docs/user/storefront/create-new-theme.mdx b/docs/user/storefront/create-new-theme.mdxdeleted file mode 100644index 066114567b..0000000000--- a/docs/user/storefront/create-new-theme.mdx+++ /dev/null@@ -1,50 +0,0 @@-----title: "Create & Publish a New Theme"-description: "Learn how to create and publish new themes in Spree Commerce."------Spree Commerce supports multiple storefront themes, allowing you to design and manage your storefront visually - without writing code or disrupting your live site.--While only one theme can be live at a time, you can freely create, duplicate, and edit themes in the background, switching them live whenever you’re ready.--## Create a New Theme--Navigate to the **Storefront** tab in the admin dashboard to view your list of themes.----You have two options to create a new one:--### Clone an Existing Theme----If you want to build off an existing layout or design, click the three dots next to the theme you want to copy and select **Clone**.--The clone will appear in your list of themes as a Draft, ready to edit without impacting the live storefront.--### Start from a Template----Scroll to the bottom of the themes list and choose from one of the available starter templates.--Click **Add**, and the new theme will be added to your theme list as a Draft.--## Edit Your Theme--Simply click on any theme in **Draft** status to open the visual page builder. You can update layouts, change styling, and preview changes in real time.--Refer to the [<u>Theme Editor</u>](https://spreecommerce.org/docs/user/storefront/theme-editor) documentation for full details on editing themes.--## Publish a Theme----When you're ready to go live with a new theme:--- Click the **Publish** button next to the theme.-- The newly published theme will be marked as **Live**.-- The previously live theme will automatically revert to **Draft**.--<Note>Only one theme can be live at a time.</Note>diff --git a/docs/user/storefront/create-page.mdx b/docs/user/storefront/create-page.mdxdeleted file mode 100644index e75509fc73..0000000000--- a/docs/user/storefront/create-page.mdx+++ /dev/null@@ -1,38 +0,0 @@-----title: "Create a Landing Page"-description: "Learn how to create new pages in Spree Commerce."------You can add custom pages to your store - such as an About Us page, a brand story page, or product-focused landing pages - without any developer assistance. These pages let you share additional content with your customers and highlight what matters most to your brand.--Although core pages like Product Details Pages (PDPs), Product Listing Pages (PLPs), and policy pages are generated automatically, Spree allows you to create as many additional pages as your store needs.--## Create a New Page--To create a new page, go to **Storefront → Pages** in the admin dashboard.----Click **Add New Page** in the top-right corner and enter a name for your new page in the form.--<Note>Optional: Adjust the SEO settings before creating the page.</Note>----Click **Create** to finalize the creation of your new page and you'll be redirected to the [<u>Theme Editor</u>](https://spreecommerce.org/docs/user/storefront/theme-editor), where you can begin customizing its layout and content.--## Customize Your Page----Once inside the Theme Editor, you can:--- Add, remove, and reorder page sections-- Insert images, text, banners, links, and more-- Adjust design settings-- Preview your changes in mobile and desktop views-- Click **Publish** when ready to save your changes--After you publish the page, it becomes immediately available on your live storefront. You can link to it in your navigation menu and other storefront sections, or use it in marketing campaigns.--For detailed instructions on working with the Theme Editor, please refer to our [<u>Theme Editor documentation</u>](https://spreecommerce.org/docs/user/storefront/theme-editor).diff --git a/docs/user/storefront/create-post.mdx b/docs/user/storefront/create-post.mdxdeleted file mode 100644index e05e6123d2..0000000000--- a/docs/user/storefront/create-post.mdx+++ /dev/null@@ -1,67 +0,0 @@-----title: "Create a Blog Post"-description: "Learn how to create a blog post in Spree Commerce."------Blog posts are a powerful tool in ecommerce. They help drive organic traffic to your store via SEO, build trust with customers, and provide opportunities to promote products or share helpful content like tutorials, stories, or news.--In Spree, adding blog posts is fast and intuitive - no developer required.--## Add a New Post--To create a blog post, navigate to **Storefront → Posts** in the Spree admin dashboard.----Click **New Post** in the top-right corner to open the post creation form.----Here you'll see several sections designed to help you create, structure, and publish your blog post.--## Post Content----This section includes the main content of your blog post.--- **Title** - The title of your blog post. This is shown on the storefront and used in the URL (slug).-- **Content** - The body of the blog post. Use the rich text editor to format text, add images, and embed videos.-- **Excerpt** - A short summary displayed on the storefront post preview and in meta tags if no meta description is set.--## Featured Image----Upload an image that will be displayed alongside the blog post in listings and previews.--<Note>Recommended dimensions: 1200 × 600 pixels.</Note>--## Post Details----This section defines important metadata for the post:--- **Author**- The admin user associated with the post. Defaults to the user creating the post.-- **Category** - Helps organize posts into high-level topics (e.g., News, Guides, Recipes).-- **Published At** - The date/time when the post should go live.-- **Tags** - Add keywords for better search filtering and to categorize posts further.--<Warning>If either **Author** or **Published At** is not set, the post will not appear on the storefront.</Warning>--## Search Engine Listing----Manage how the post appears in search engine results (all optional):--- **Meta Title** - defaults to the Title if left blank.-- **Meta Description** - defaults to the Excerpt if left blank.-- **Slug** - defaults to a URL-friendly version of the Title if left blank.--## Create the Post--Once all sections are filled out, click **Create** at the bottom of the page to finalize your new post.--Your post will now be published and visible on the storefront (if a Published At date is set). You can return to this section at any time to edit or delete the post.diff --git a/docs/user/storefront/delete-page.mdx b/docs/user/storefront/delete-page.mdxdeleted file mode 100644index 0ea0c1da98..0000000000--- a/docs/user/storefront/delete-page.mdx+++ /dev/null@@ -1,20 +0,0 @@-----title: "Delete a Landing Page"-description: "Learn how to delete custom pages in Spree Commerce."------If a landing page is no longer needed, you can delete it directly from the Pages list to keep your admin area organized.--## Delete a Page--To delete a page, go to **Storefront → Pages** in the admin dashboard, and find the page you want to remove.----Click the **three-dot menu** on the right side of the page row.----Then simply select **Delete** and confirm the deletion when prompted.--The page will be removed immediately and will no longer appear on your storefront.diff --git a/docs/user/storefront/delete-post.mdx b/docs/user/storefront/delete-post.mdxdeleted file mode 100644index dd71241f51..0000000000--- a/docs/user/storefront/delete-post.mdx+++ /dev/null@@ -1,28 +0,0 @@-----title: "Delete a Blog Post"-description: "Learn how to delete a blog post in Spree Commerce."------Need to remove outdated or irrelevant content? Deleting a blog post in Spree is quick and easy.--## When to Delete a Post--You might want to delete a post if:--- It's no longer relevant-- It's out of date-- It no longer aligns with your content strategy--## How to Delete a Blog Post--To delete a blog post, navigate to **Storefront → Posts** in the admin dashboard.----Click on the post you want to delete to open the post editor, scroll to the bottom of the page and click **Delete** in the bottom-right corner.----Once deleted, the post will be removed from your site immediately.--<Warning>This action cannot be undone. Once deleted, the post and its content cannot be recovered.</Warning>diff --git a/docs/user/storefront/delete-theme.mdx b/docs/user/storefront/delete-theme.mdxdeleted file mode 100644index e3cefc4156..0000000000--- a/docs/user/storefront/delete-theme.mdx+++ /dev/null@@ -1,17 +0,0 @@-----title: "Delete a Theme"-description: "Learn how to delete a storefront theme in Spree Commerce."------If you need to remove a theme from your store - for example, to clean up unused drafts or simplify theme management - you can do so easily from the Spree dashboard.--### How to Delete a Theme----1. Navigate to the **Storefront** tab of the admin dashboard.-2. Locate the theme you want to delete.-3. Click the three-dot menu (`⋯`) on the right-hand side of the theme card.-4. Select **Delete** from the dropdown menu.--<Note>Only **Draft** themes can be deleted. Published themes must be unpublished or replaced before they can be removed.</Note>diff --git a/docs/user/storefront/edit-page.mdx b/docs/user/storefront/edit-page.mdxdeleted file mode 100644index f79dd94d6e..0000000000--- a/docs/user/storefront/edit-page.mdx+++ /dev/null@@ -1,51 +0,0 @@-----title: "Edit a Landing Page"-description: "Learn how to edit custom landing pages in Spree Commerce."------Learn how to edit custom landing pages in Spree Commerce.--You can easily update the content, layout, or product sections on your custom landing pages directly through the Theme Editor - no developer help required.--## Edit a Page--To edit a page, go to **Storefront → Pages** in the admin dashboard.----Find the page you want to edit and click on it and you’ll be taken to the [<u>Theme Editor</u>](https://spreecommerce.org/docs/user/storefront/theme-editor) for that specific page.----From here, you can update the page just like any other customizable page in the Theme Editor.--## Make Changes in the Theme Editor--Inside the Theme Editor, you can:--- Add, remove, or reorder page sections-- Update images, text, and other content-- Adjust design settings-- Preview your changes on mobile and desktop-- **Publish** your updates when ready--<Warning>Be sure to click **Publish** when you're finished, otherwise your changes will not be saved or published to the live site.</Warning>--For more information on how to work with the Theme Editor, please refer to our [<u>Theme Editor documentation</u>](https://spreecommerce.org/docs/user/storefront/theme-editor).--## Edit Page Settings----In the top-left corner of the Theme Editor, click **Settings** to open up settings window.----Here you can edit:--- Page name-- Meta title-- Meta description-- URL slug--You can also delete the page from this window if needed. After making updates, click **Save**.diff --git a/docs/user/storefront/edit-post.mdx b/docs/user/storefront/edit-post.mdxdeleted file mode 100644index c08dc07e44..0000000000--- a/docs/user/storefront/edit-post.mdx+++ /dev/null@@ -1,22 +0,0 @@-----title: "Edit a Blog Post"-description: "Learn how to edit a blog post in Spree Commerce."------Updating blog content is a great way to keep your posts accurate, relevant, and SEO-optimized. Whether you’re fixing a typo, updating a link, or revising product details, editing a blog post is simple.--## How to Edit a Blog Post--To edit a blog post, go to **Storefront → Posts** in the admin dashboard.----Locate the post you want to edit and click on it to open the blog post editor.----Make any necessary changes to the content, SEO settings, featured image, or metadata.--When you’re finished, click **Update** to save your changes.--<Warning>Changes won’t be saved unless you click **Update**.</Warning>diff --git a/docs/user/storefront/import-posts.mdx b/docs/user/storefront/import-posts.mdxdeleted file mode 100644index 343d8a4275..0000000000--- a/docs/user/storefront/import-posts.mdx+++ /dev/null@@ -1,5 +0,0 @@-----title: "Import Blog Posts"-description: "Import blog posts from a file to quickly migrate your Wordpress or Shopify blog and start using your built-in Spree Commerce blog."-----diff --git a/docs/user/storefront/product-details-page.mdx b/docs/user/storefront/product-details-page.mdxdeleted file mode 100644index 84f89f54b4..0000000000--- a/docs/user/storefront/product-details-page.mdx+++ /dev/null@@ -1,138 +0,0 @@-----title: "Product Details Page"-description: "Learn how to customize the Product Details Page in Spree Commerce."------A well-designed Product Details Page (PDP) plays an essential role in helping customers understand your products and complete their purchase with confidence.--Spree gives you full visual control over how product information is presented by adding a flexible drag-and-drop layout editor, enhanced metafield management, and complete control over the visibility and order of core product elements - all without writing a single line of code.--This guide shows you how to customize the PDP using the Spree theme editor.--## Access the PDP Editor--To begin customizing the Product Details Page, first navigate to **Storefront → Themes**.----Open your active theme (i.e., the one marked Live).----In the page selector (top left), choose **Product Details Page**.----The editor preview and sidebar will update to show all PDP-specific sections and settings.----<Warning>Remember to click Publish after making changes. Navigating away from the editor without publishing will discard all changes.</Warning>--## Edit the PDP Layout--The PDP layout can be controlled entirely through the sidebar, where each element is displayed as its own draggable block.----From here, you can customize the PDP in a number of ways:--### Reorder Elements----To change the order in which product information appears:--1. Locate the PDP element list in the sidebar-2. Click and hold the handle icon next to an element-3. Drag it to its new position-4. Release to drop it in place--This allows you to design layouts such as:--- Price at the top for conversion-focused layouts-- Brand name above product title-- Description above the variant selector-- Metafields grouped under Add to Cart--The editor preview updates instantly so you can see your changes immediately.--<Note>Some merchants prefer a shorter “buy box” on mobile. Use the mobile preview toggle to optimize the PDP for smaller screens.</Note>--### Modify Design Settings----Clicking any PDP element opens up its settings, which may include:--- Padding-- Alignment-- Borders-- Color adjustments (if not overridden by global settings)--These settings vary depending on the selected block, similar to other pages in the theme editor.--Just like other customizable pages in the theme editor, you can insert page sections above or below the PDP’s main content area.--### Add/Remove Page Sections----To add more page sections, click **Add Section** in the sidebar, and choose from the list of available page sections (such as Image Banner, Featured Taxon, etc.).--The section will be added to the PDP layout, where you can edit and rearrange it like any other section.--These sections allow you to enrich the PDP with supplementary content, such as promotional banners, brand messaging, or custom visuals.--## Manage Product Metafields--The Metafields block is fully configurable and can display any additional product data you’ve added - such as ingredients, materials, certifications, allergens, origin, care instructions, and more.--### Show or Hide Metafields----Each metafield appears in the sidebar with a simple checkbox:--- **Checked** - metafield is visible on the PDP-- **Unchecked** - metafield is hidden from the PDP--This allows you to display only the information that matters most for each store.--### Reorder Metafields----Metafields can also be rearranged via drag-and-drop:--1. Go to the Metafields block inside the PDP editor-2. Use the handle icon next to a metafield to drag it up or down-3. Drop it into your preferred order--This is especially useful for merchants with many metafields, allowing them to highlight the most important information first.--<Note>If you have not created any product metafields, then this section will appear blank. Please refer to our [<u>Metafields</u>](https://spreecommerce.org/docs/user/settings/metafields) support article to learn more.</Note>--## Preview Your Changes----Use the controls in the top toolbar to view your PDP as customers would see it:--- **Mobile View** - preview the mobile layout-- **Desktop View** - preview the full PDP as shown on desktop-- **Preview Mode** - open a live preview outside of the editor--This ensures your PDP looks consistent and polished across all devices.--## Publish Your Changes----Once your PDP layout is ready:--- Click **Publish** in the top right corner-- Your changes go live immediately-- Revisit the editor at any time to adjust the layout or metafields--<Note>If you feel like you’ve made a complete mess of the layout, and would like to revert it back to its original configuration, simply exit the theme editor without clicking Publish and your changes will be discarded.</Note>diff --git a/docs/user/storefront/product-listing-page.mdx b/docs/user/storefront/product-listing-page.mdxdeleted file mode 100644index 30c6ea48e7..0000000000--- a/docs/user/storefront/product-listing-page.mdx+++ /dev/null@@ -1,131 +0,0 @@-----title: "Product Listing Page"-description: "Learn how to customize product listing pages in Spree Commerce."------Product Listing Pages (PLPs) display groups of products and help customers browse your catalog. In Spree, three types of pages act as PLPs and can be customized in the Theme Editor:--- **Shop All** - a standalone page showing your entire product catalog-- **Taxon pages** - one for each category, collection, or brand-- **Search Results** - dynamically shows products based on the customer’s search query--Each of these pages includes a product grid section that cannot be removed, ensuring a consistent product-browsing experience across your storefront. However, you can add additional sections to shape the layout and highlight promotions, brand messaging, or featured content.--## How to Edit Product Listing Pages--To edit a PLP, first go to **Storefront → Themes** in the admin dashboard.----Open your active theme, and use the page selector at the top left of the Theme Editor to choose Shop All, Taxon, or Search Results.----The preview and sidebar will update based on your selection.--### Edit the Shop All Page----The Shop All page displays every product in your store and is fully customizable through the Theme Editor. There are two default sections:--#### Title Section--The Shop All page includes a title block at the top of the page body.--This block is editable and removable if you prefer a minimal layout or want to replace it with your own custom section.--#### Product Grid--The product grid list all of the items in your product catalog and is non-removable.--You can adjust its design settings (spacing, padding, etc.), but not delete it.--#### Adding Additional Sections--You can add page sections above or below the product grid to feature:--- Promotional banners-- Text and image blocks-- Custom content areas-- Seasonal messaging--For more information about adding page sections, please refer to our [<u>Theme Editor</u>](https://spreecommerce.org/docs/user/storefront/theme-editor) support article.--### Edit the Taxon Page----Taxon pages display products belonging to a specific category, collection, or brand. Although each taxon has its own content (name, banner, products), the layout is shared across all taxon pages.--#### Taxon Banner--Each taxon page includes a non-removable banner section at the top.--It automatically displays:--- The **taxon name **and-- The **taxon banner image**, if one is set in the admin dashboard-- The **singularized taxonomy name** above the taxon name (e.g., a taxon under _Categories_ will show _Category_)--This ensures consistent category presentation throughout your store.--#### Product Grid--The product grid displays all products within a given taxon, is non-removable, and appears below the taxon banner.--Its design settings can be adjusted, but the core functionality remains unchanged.--#### Adding Additional Sections--You can add sections to taxon pages, but with one important note: Any section you add will appear on every taxon page.--This is because all taxon pages share one layout in the Theme Editor.--Therefore, avoid adding content that is specific to a single category. Instead, focus on global elements such as:--- Category-specific promotional banners-- Universal messaging-- Brand-aligned visuals-- Featured content relevant only to some taxons--For more information about adding page sections, please refer to our [<u>Theme Editor</u>](https://spreecommerce.org/docs/user/storefront/theme-editor) support article.--### Edit the Search Results Page----The Search Results page displays products matching a customer’s search query.--#### Title Section--The page includes a default Search Results title block, which is both editable and removable.--You can customize the text or replace it with your own page sections.--#### Product Grid--The product grid displays all products that match the search query and is non-removable.--It automatically updates based on the user’s search term.--#### Adding Additional Sections--As with other PLPs, you can add additional sections to provide:--- Search-related messaging-- Banners to promote best sellers-- Helpful visual content-- Notices or suggestions--These additions apply only to the Search Results page.--For more information about adding page sections, please refer to our [<u>Theme Editor</u>](https://spreecommerce.org/docs/user/storefront/theme-editor) support article.--## Publishing Changes--After adjusting any PLP, make sure to click **Publish** in the top-right corner.--Your changes will appear immediately on the live storefront.--You can return to the Theme Editor at any time to update the layout.diff --git a/docs/user/storefront/search-posts.mdx b/docs/user/storefront/search-posts.mdxdeleted file mode 100644index 8439f143fc..0000000000--- a/docs/user/storefront/search-posts.mdx+++ /dev/null@@ -1,24 +0,0 @@-----title: "Searching Blog Posts"-description: "Search for blog posts in the backend allows you to quickly locate specific content for updates, edits, or review, saving time when managing multiple posts."------Searching for blog posts in the backend allows you to quickly locate specific content for updates, edits, or review, saving time when managing multiple posts. It also helps you maintain organization by easily accessing posts based on titles, authors, or other criteria.--To search blog posts, navigate to the Posts tab of the admin dashboard found under Storefront.----Click on the ‘Filters’ button at the top of the list and to the right of the search bar. This will open the filters UI.----Here you’ll find three options to help refine your search for blog posts.:--* Title Link - filters results by post name or a term included in the name--* Author - filters results by the author of the post--* Category - filters results by the category the post belong to--Using these filters will make blog management much easier, especially if you have a large number of posts.\ No newline at end of filediff --git a/docs/user/storefront/storefront-settings.mdx b/docs/user/storefront/storefront-settings.mdxdeleted file mode 100644index fa08f7b01d..0000000000--- a/docs/user/storefront/storefront-settings.mdx+++ /dev/null@@ -1,104 +0,0 @@-----title: "Storefront Settings"-description: "Learn how to configure storefront settings like security, favicon, custom head/body tags, and more."------Configure your store’s visual identity, search visibility, social presence, and custom code snippets with ease using Spree’s Storefront Settings.--These settings help you:--- Improve branding and recognition (favicon, social links)-- Control search engine indexing and social sharing previews-- Add custom code for tracking or personalization-- Ensure a polished, professional storefront experience--To access storefront settings, go to **Settings → Storefront** in the admin dashboard.----Here you'll see several sections that allow you to configure key storefront settings related to SEO, branding, appearance, and more.--## SEO----Control how your store appears in search engines and social media previews.--- **SEO Title** - Appears in social shares, browser tabs, and search results.-- **Meta Description** - A short summary of your store that shows up in search listings and social previews.-- **Index in Search Engines** - Toggle this to allow or prevent your store from being indexed.- - You may want to disable indexing if:- - Your site is still in development- - You’re making major content/design changes- - You run a member-only platform and want to restrict access- - Otherwise, make sure indexing is enabled when going live.--## Security----Restrict access to your storefront with a password.--To enable password protection:--1. Check the Password Protected box - this reveals the Password field-2. Enter your desired password into the field-3. Click **Update** to save the password--This is useful for stores in development or platforms offering exclusive, member-only access.--## Custom Code----Add third-party tools or advanced customization by injecting code snippets.--- **Head Tag** - Ideal for analytics scripts, SEO metadata, or style overrides.-- **After \<body\>** or **Before \</body\>** - Great for tracking scripts or additional JavaScript.--Simply enter the code in the appropriate box and click **Update**.--## Images--### Favicon Image----The small icon shown in browser tabs, bookmarks, and search previews.--- Recommended size: 120×120px-- Simply upload your image and click **Update**-- Helps reinforce brand recognition and professionalism.--### Preview Image----Displayed when your site is shared on social media or messaging apps.--- Recommended size: 1200×600px-- Upload and click **Update**-- A compelling preview image can increase clicks and improve brand recall.--## Social Media Links----Add social handles to your footer, complete with platform-specific icons.--Supported platforms:--- TikTok-- YouTube-- Spotify-- Discord--Simply enter your links and click **Update**.--## Don’t Forget to Click Update--Once you’ve made changes to any of the sections above, make sure to click **Update** at the top or bottom of the page to save your changes.diff --git a/docs/user/storefront/theme-editor.mdx b/docs/user/storefront/theme-editor.mdxdeleted file mode 100644index e27f7866b6..0000000000--- a/docs/user/storefront/theme-editor.mdx+++ /dev/null@@ -1,194 +0,0 @@-----title: "Theme Editor"-description: "Learn how to use the Theme Editor to customize your storefront in Spree Commerce."------A visually appealing and well-organized storefront is essential for any online business. It builds trust with customers and can significantly improve your conversion rates.--The Spree theme editor provides a powerful, no-code, drag-and-drop page builder that allows you to visually design your storefront, reflect your brand identity, and preview changes in real time - without writing a single line of code or hiring developers.--## How to Edit Your Theme--To edit your storefront’s theme, navigate to **Storefront → Themes** in the admin dashboard.----Find the theme with the status **Live** and click on it to open the theme editor.----<Warning>It’s useful to note before we go further that you should always click **Publish** in the top-right corner to save your changes. Leaving the editor without publishing will discard all unsaved edits.</Warning>--Let’s walk through the different areas of the page builder.--## Top Navigation----The top navigation bar allows you to switch between pages, adjust global settings, and preview different views of the storefront.--This gives you access to the following controls and settings:--### Page Selector----In the top-left dropdown, choose which page you want to edit. The editor will reload with the selected page's layout and elements.--### Color Scheme----Click the **palette icon** to open the global color settings. You can change the default colors used across all pages.--Click any colored circle to open the color editor, where you can:-- Enter a hex code manually-- Adjust the hue and saturation-- Control transparency using the right-hand slider--### Fonts----Click the **A icon** to change fonts. You can choose from:-- **Standard Fonts** - Select separate font families and sizes for body text and headings using dropdowns and sliders.-- **Custom Fonts** - Add custom fonts by pasting the embed and style code.--### Views----Located in the middle of the-- **Mobile View** - Preview how the storefront looks on mobile devices.-- **Desktop View** - Preview how the storefront looks on desktop devices.--## Side Navigation----The side navigation allows you to add, configure, and arrange page sections and individual content blocks.--### Page Section Settings----Click on any page section or element to configure its content and appearance. Most page sections have two distinct tabs:-- **Content Settings** - Edit text, links, images, and other content-- **Design Settings** - Change padding, borders, alignment, color, and sometimes layouts--## Global Page Sections--Global sections appear across every page (besides checkout) and update everywhere when edited. They can be modified via the Side Navigation. Global page sections are as follows:--### Announcement Bar----Add a message that appears at the very top of every page. Ideal for welcome messages and promos like free shipping or limited-time discounts.--### Page Header----The header includes your:--- Logo-- Navigation links-- Search bar-- Cart icon-- Account menu--#### Add Logo--Click **Header** and upload your logo. You can resize its presentation in the **Design** tab.--#### Add Links--Click **Add Link** to add navigation items.--Link Types are as follows:-- Page (e.g. About Us, Blog)-- Product-- Post (blog)-- Taxon (category)-- Policy (e.g. Terms)-- URL (external or internal)--You can also choose to have the link open in a new tab.--#### Add Blocks----Click **Add Block** to configure a more advanced header layout. You can select from the following block types:-- **Mega Nav with Subcategories** - Add a dropdown menu populated from a chosen taxon and its subtaxons. Optionally feature a highlighted taxon with image.-- **Mega Nav** - Manually add links to columns within a dropdown layout for full control over structure.-- **Link** - A simple link to taxon, product, policy or any other page.--### Newsletter----A global email capture section to build your subscriber list. Customize text and styling as needed.--### Footer----Add:-- Your logo-- Policy links-- Product category links-- Social media links--Organize content into blocks using **Add Block**, and add links as you did in the Header section.--## Page-Specific Sections--These only appear on the page they’re added to - ideal for storytelling, product discovery, and homepage content.--### Add Page Sections----Click **Add Section** in the sidebar, then choose a layout type from the following options:--- Breadcrumbs-- Custom Code-- Featured Posts-- Featured Product-- Featured Taxon-- Featured Taxons-- Image Banner-- Image With Text-- Page Title-- Related Products-- Rich Text-- Video--The newly added section will appear at the bottom of the page, but above the footer and newsletter.--### Edit Page Sections and Elements--Click on a section in the sidebar or directly in the preview to update content or design. All changes reflect immediately in the editor preview.--### Rearrange Page Sections and Elements----To move a page section or element, hover over it in the preview to reveal the actions menu, then use the up and down arrows to reposition it to the desired location on the page.--### Delete Sections and Elements----You can either:--- Select a section and click **Delete** at the bottom left of the side navigation-- Hover over an element in the preview and click the trash can icon--## Publish--Once you’re finished modifying your storefront theme, click **Publish** in the top right corner to save and apply your changes to the live storefront immediately.--<Warning>Any changes you make in the editor are **not saved** until you click **Publish**. If you do not wish to save your changes, simply back out of the theme editor.</Warning>diff --git a/docs/user/user-quickstart-guide.mdx b/docs/user/user-quickstart-guide.mdxindex 655d748d15..5daa207047 100644--- a/docs/user/user-quickstart-guide.mdx+++ b/docs/user/user-quickstart-guide.mdx@@ -110,129 +110,6 @@ See [<u>Shipping Methods</u>](https://spreecommerce.org/docs/user/settings/shipp<Note>By default, all Spree stores have a Digital Delivery method pre-configured. If you plan on selling digital products, be sure to assign those products the Digital shipping category.</Note>-## Storefront Setup----Once your product catalog, payments, taxes, and shipping are ready, it's time to build your storefront. Spree gives you a built-in visual page builder that lets you design your storefront without writing any code.--Navigate to **Storefront** in the admin dashboard to access:--### Themes----Here you can customize the design, layout, and branding of your storefront, and add new themes that you can switch between when desired.--Simply click on the theme you wish to edit to launch the Theme Editor.----If this is a fresh Spree installation, you’ll see the blank, default layout. However, here you can easily:--- Add and arrange pre-built page sections-- Update global theme settings like fonts and colors-- Upload and swap out media in individual sections-- Switch between mobile and desktop editor preview-- Click **Publish** in the top right when you're ready to save changes--For a detailed guide on customizing your storefront theme, please refer to our [<u>Theme Editor support article</u>](https://spreecommerce.org/docs/user/storefront/theme-editor).--<Warning>Changes are only saved when published. Previewing alone does not make them live.</Warning>--### Connect Your Domain----At the top of the Themes section, click **Connect your own domain** to add a custom domain or subdomain. This will redirect you to **Settings → Domains** where you can complete the setup of your custom domain.--### Pages----Use the Pages section to add static pages like:--- About Us-- Contact-- Custom landing pages--Click **Add new page** and fill in the page name and SEO fields.----Click Create to finalize the settings of the new page, and you’ll be taken directly to the Theme Editor to edit the content of your new page.--To learn more about Pages, please refer to our [<u>Pages</u>](https://spreecommerce.org/docs/user/storefront/create-page) support article.--### Posts----Spree includes a built-in blogging tool that’s great for content marketing and SEO.--To add a blog post, go to **Storefront → Posts** and click **New Post**.----Simply, fill in your post content, image, and SEO fields, set a Published At date, and click **Create** to finalize your new post.--To learn more about Posts, please refer to our [<u>Posts</u>](https://spreecommerce.org/docs/user/storefront/create-post) support article.--### Storefront Settings----In **Storefront → Settings**, you can control:--- SEO settings, including search engine indexing preferences-- Favicon and social share images-- Social media links-- Custom code snippets to add to head and body tags-- Storefront password protection preferences--Make sure to click **Update** to save your changes.--<Note>To appear in search results, make sure **Index in search engines** is checked.</Note>--## Managing Multiple Stores----If you need to launch multiple storefronts (e.g., for different regions or brands), you can create a new store by clicking the **\+** button next to your store name (top-left) and selecting **New Store**.----You’ll be asked to:--- Name the store-- Choose a country, currency, and locale-- Decide whether to import products and payment methods from the current store--Each store can operate independently and have unique designs, catalogs, and settings, but they all share customers, admin users, and some other configurations.--Learn more about managing multiple stores in our [<u>multi-store use case documentation</u>](https://spreecommerce.org/docs/use-case/multi-store/model).--## Analytics----Your Spree dashboard Home tab gives you high-level insights into store performance.--You’ll see:--- Key Sales KPIs for revenue, orders, AOV and sign-ups-- A list of top selling products over the selected time range--Use the date selector to change the reporting period at any time.--Similarly, you can view and export sales reports from the Reports tab:----### 3rd Party Tools--For more detailed analytics, we recommend using our native [<u>Google Analytics 4</u>](https://spreecommerce.org/docs/integrations/analytics/google-analytics) or [<u>Google Tag Manager</u>](https://spreecommerce.org/docs/integrations/analytics/google-tag-manager) integration.-## Next StepsOnce you’ve completed the basic setup, you’re ready to explore more advanced features and tailor your store to your business model. Here’s some recommended reading: