@spree/docs 0.1.176 → 0.1.178

package/dist/developer/multi-vendor/installation.md

@@ -1,61 +0,0 @@
----
-title: Spree Multi Vendor Installation
-sidebarTitle: Installation
-description: Install and configure Spree Multi-Vendor to launch a marketplace with multiple vendors, including prerequisites, gem setup, license keys, and vendor onboarding.
----
-
-> **WARNING:** This installation instructions assume you have purchased the [Spree Enterprise Edition license](https://spreecommerce.org/pricing).
-
-## Prerequisites
-
-* You need to be on Spree 5.1+, we recommend using [spree_starter](https://github.com/spree/spree_starter) as a base for your application
-* You need to have 2 environment variables set:
-  * `KEYGEN_ACCOUNT_ID`
-  * `KEYGEN_LICENSE_KEY`
-* We support both PostgreSQL and MySQL databases
-* Redis/Valkey for background jobs
-
-> **INFO:** Environment variables will be provided to you after purchasing the [Spree Enterprise Edition license](https://spreecommerce.org/pricing).
-
-> **WARNING:** You will need to add these environment variables to your CI/CD pipeline and production environments.
-
-## Installing gems
-
-1. Add the following code to your `Gemfile`:
-
-    ```ruby
-    source "https://license:#{ENV['KEYGEN_LICENSE_KEY']}@rubygems.pkg.keygen.sh/#{ENV['KEYGEN_ACCOUNT_ID']}" do
-      gem 'spree_enterprise'
-      gem 'spree_multi_vendor'
-    end
-    ```
-
-2. Install gems:
-
-    
-
-    ```bash Spree CLI (Docker)
-    spree bundle install
-    ```
-
-    ```bash Without Spree CLI
-    bundle install
-    ```
-
-    
-
-3. Run generators:
-
-    
-
-    ```bash Spree CLI (Docker)
-    spree generate spree_enterprise:install && spree generate spree_multi_vendor:install
-    ```
-
-    ```bash Without Spree CLI
-    bin/rails g spree_enterprise:install && bin/rails g spree_multi_vendor:install
-    ```
-
-    
-
-    > **INFO:** This will copy and run migrations for `spree_enterprise` and `spree_multi_vendor` gems.

package/dist/developer/multi-vendor/quickstart.md

@@ -1,17 +0,0 @@
----
-title: Building a Multi-Vendor Marketplace with Spree
-sidebarTitle: Quickstart
----
-
-If you want to have a true multi-vendor marketplace, you will need to purchase [Enterprise Edition license](https://spreecommerce.org/pricing) which includes `spree_multi_vendor` gem providing full multi-vendor support.
-
-## What is included in `spree_multi_vendor`
-
-1. **Ability to invite and manage vendors**, their products and orders
-2. Full fledged **vendor dashboard** where vendors can self-serve orders, products, manage their team, etc.
-3. White-label **Shopify Sales Channel application** allowing vendors to connect their Shopify stores, import products, shipping rates and receive orders to fulfill them like a regular order in their Shopify store.
-4. White-label **WooCommerce application** allowing vendors to connect their WooCommerce stores, import products, shipping rates and receive orders to fulfill them like a regular order in their WooCommerce store
-5. **Stripe Connect** integration allowing vendors to receive payments directly to their Stripe accounts, split payments between marketplace and vendors, automated payouts and more
-6. **Multi-party checkout** allowing customers to checkout with multiple vendors, split payments between them and receive separate invoices for each vendor
-7. **Flexible permission system** to tailor the marketplace to your needs (eg. disable/enable vendor panel features)
-8. **Vendor API** endpoints to allow vendors to manage their products, orders, etc.

package/dist/developer/tutorial/admin.md

@@ -1,206 +0,0 @@
----
-title: Admin Dashboard
-description: Scaffold the Spree admin UI for the Brands resource and add a rich text description editor, an Active Storage logo upload, and a custom table column.
----
-
-> **NOTE:** This is a backend customization. You need to perform it in the `backend` directory if you used `create-spree-app` to set up your Spree application.
-
-Now that we've created the `Brand` model, let's create an Admin Dashboard interface so admins can manage brands — including editing the rich text description and uploading the logo.
-
-## Step 1: Scaffold the Admin UI
-
-The Admin Scaffold generator creates a complete admin section for a resource:
-
-
-```bash Spree CLI (Docker)
-spree generate spree:admin:scaffold Spree::Brand
-```
-
-```bash Without Spree CLI
-bin/rails g spree:admin:scaffold Spree::Brand
-```
-
-
-This will create the following files:
-
-| File Type | Path | Description |
-|-----------|------|-------------|
-| Controller | `app/controllers/spree/admin/brands_controller.rb` | Handles the logic for the brands resource. |
-| View | `app/views/spree/admin/brands/index.html.erb` | Displays the list of brands using the tables system. |
-| View | `app/views/spree/admin/brands/new.html.erb` | Displays the new brand form. |
-| View | `app/views/spree/admin/brands/edit.html.erb` | Displays the edit brand form. |
-| Partial | `app/views/spree/admin/brands/_form.html.erb` | The form partial used in new and edit views. |
-| Initializer | `config/initializers/spree_admin_brands_table.rb` | Registers the table with columns for the index view. |
-| Initializer | `config/initializers/spree_admin_brands_navigation.rb` | Adds navigation to the admin sidebar. |
-
-It will also automatically add the following routes to your `config/routes.rb` file:
-
-```ruby config/routes.rb
-namespace :admin do
-  resources :brands
-end
-```
-
-You will now be able to access the brands resource at `http://localhost:3000/admin/brands` in your browser. To reference this route in your code, you can use the `spree.admin_brands_path` helper.
-
-## Step 2: Add the Description Editor and Logo Upload
-
-The generated form only knows about the `name` column. Let's add the rich text editor for `description` and the upload field for `logo` using Spree's [admin form builder](../admin/form-builder.md):
-
-```erb app/views/spree/admin/brands/_form.html.erb {4,9-16}
-<div class="card mb-6">
-  <div class="card-body">
-    <%= f.spree_text_field :name, required: true, autofocus: true %>
-    <%= f.spree_rich_text_area :description %>
-  </div>
-</div>
-
-<div class="card mb-6">
-  <div class="card-header">
-    <h5 class="card-title"><%= Spree.t(:logo) %></h5>
-  </div>
-  <div class="card-body">
-    <%= f.spree_file_field :logo, width: 300, height: 300 %>
-  </div>
-</div>
-```
-
-- **`spree_rich_text_area`** renders a WYSIWYG editor (Trix) for the Action Text description.
-- **`spree_file_field`** handles drag-and-drop upload, image preview, and direct upload to storage. Add `crop: true` to enable image cropping with a recommended-size indicator.
-
-Then permit the two new attributes in the controller:
-
-```ruby app/controllers/spree/admin/brands_controller.rb {7-11}
-module Spree
-  module Admin
-    class BrandsController < ResourceController
-      private
-
-      def permitted_resource_params
-        params.require(:brand).permit(
-          :name,
-          :description,
-          :logo
-        )
-      end
-    end
-  end
-end
-```
-
-Open `http://localhost:3000/admin/brands/new`, create a brand with a formatted description and a logo — everything saves through the standard form.
-
-## Step 3: Customize the Table Columns
-
-The scaffold generator creates a table initializer at `config/initializers/spree_admin_brands_table.rb` with default columns:
-
-```ruby config/initializers/spree_admin_brands_table.rb
-Rails.application.config.after_initialize do
-  Spree.admin.tables.register(:brands, model_class: Spree::Brand, search_param: :name_cont)
-
-  Spree.admin.tables.brands.add :name,
-    label: :name,
-    type: :link,
-    sortable: true,
-    filterable: true,
-    default: true,
-    position: 10
-
-  Spree.admin.tables.brands.add :created_at,
-    label: :created_at,
-    type: :datetime,
-    sortable: true,
-    filterable: true,
-    default: true,
-    position: 20
-
-  Spree.admin.tables.brands.add :updated_at,
-    label: :updated_at,
-    type: :datetime,
-    sortable: true,
-    filterable: true,
-    default: false,
-    position: 30
-end
-```
-
-### Show the logo next to the name
-
-To render the logo thumbnail in the name column — the same pattern the Products table uses — switch the column to a custom partial:
-
-```ruby config/initializers/spree_admin_brands_table.rb
-Spree.admin.tables.brands.add :name,
-  label: :name,
-  type: :custom,
-  partial: 'spree/admin/tables/columns/brand_name',
-  sortable: true,
-  filterable: true,
-  default: true,
-  position: 10
-```
-
-And create the partial:
-
-```erb app/views/spree/admin/tables/columns/_brand_name.html.erb
-<%# locals: (record:, column:, value:) %>
-<%= link_to spree.edit_admin_brand_path(record), class: 'flex items-center gap-3 no-underline', data: { turbo_frame: '_top' } do %>
-  <% if record.logo.attached? %>
-    <%= spree_image_tag record.logo, width: 48, height: 48, class: 'rounded' %>
-  <% end %>
-  <span class="text-gray-900 font-medium"><%= record.name %></span>
-<% end %>
-```
-
-> **INFO:** For complete table customization options including column types, filtering, sorting, and bulk actions, see the [Admin Tables](../admin/tables.md) guide.
-
-## Step 4: Customize Navigation
-
-The scaffold generator also creates a navigation initializer at `config/initializers/spree_admin_brands_navigation.rb`:
-
-```ruby config/initializers/spree_admin_brands_navigation.rb
-Rails.application.config.after_initialize do
-  Spree.admin.navigation.sidebar.add :brands,
-    label: :brands,
-    url: :admin_brands_path,
-    icon: 'list',
-    position: 55,
-    active: -> { controller_name == 'brands' },
-    if: -> { can?(:manage, Spree::Brand) }
-end
-```
-
-You can customize the icon and position to fit your needs. For example, to use the "award" icon and place it between Products (30) and Customers (40):
-
-```ruby
-Spree.admin.navigation.sidebar.add :brands,
-  label: :brands,
-  url: :admin_brands_path,
-  icon: 'award',
-  position: 35,
-  active: -> { controller_name == 'brands' },
-  if: -> { can?(:manage, Spree::Brand) }
-```
-
-### Adding to an Existing Submenu
-
-To add "Brands" to the Products submenu instead, use the `parent` option:
-
-```ruby config/initializers/spree_admin_brands_navigation.rb
-Rails.application.config.after_initialize do
-  Spree.admin.navigation.sidebar.add :brands,
-    label: :brands,
-    url: :admin_brands_path,
-    position: 50,
-    parent: :products,
-    active: -> { controller_name == 'brands' },
-    if: -> { can?(:manage, Spree::Brand) }
-end
-```
-
-After restarting your server, you'll see the new "Brands" navigation link in the admin sidebar!
-
-> **INFO:** For complete navigation API documentation including all available options, submenu creation, badges, and more, see the [Admin Navigation](../admin/navigation.md) guide. The form helpers used in Step 2 are documented in [Form Builder](../admin/form-builder.md) and [Components](../admin/components.md).
-
-## Next Step
-
-Brands are manageable in the admin. Now let's connect them to Products: [Extending Core Models](extending-models.md).