@spree/docs 0.1.177 → 0.1.178

package/dist/developer/upgrades/5.6-to-6.0.md

@@ -4,7 +4,7 @@ description: Guide to upgrading a Spree 5.6 application to Spree 6.0
 hidden: true
 ---
 
-> **INFO:** Before proceeding to upgrade, please ensure you're at [Spree 5.6](5.5-to-5.6.md). Spree 6.0 requires **Rails 8.1** and is the designated breaking-change window for the platform — read the behavioral changes section even if your upgrade runs clean.
+> **INFO:** Before proceeding to upgrade, please ensure you're at [Spree 5.6](/v5/developer/upgrades/5.5-to-5.6). Spree 6.0 requires **Rails 8.1** and is the designated breaking-change window for the platform — read the behavioral changes section even if your upgrade runs clean.
 
 Spree 6.0 is a major release. The headline changes:
 
@@ -440,7 +440,7 @@ buckets, and only the last needs this hook:
 
 | What you were adding | Where it goes in 6.0 |
 | --- | --- |
-| A merchant-managed field (text, number, dropdown) | [Custom Fields](../core-concepts/custom-fields.md) — no code, and filterable/sortable |
+| A merchant-managed field (text, number, dropdown) | [Custom Fields](../core-concepts/metafields.md) — no code, and filterable/sortable |
 | Config for an STI type you register (promotion rule, delivery method rule, …) | `additional_permitted_attributes` on that subclass, as before — unchanged |
 | A real database column your extension added to a core model | `additional_permitted_attributes` on the model |
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spree/docs",
-  "version": "0.1.177",
+  "version": "0.1.178",
   "description": "Spree Commerce developer documentation for AI agents and local reference",
   "type": "module",
   "license": "CC-BY-4.0",

package/dist/developer/admin/admin.md

@@ -1,214 +0,0 @@
----
-title: Admin Dashboard
-sidebarTitle: Overview
-description: Customize and extend the Spree Admin Dashboard to manage products, orders, customers, promotions, and store settings for your ecommerce platform.
----
-
-The Spree Admin Dashboard is a full-featured administration interface for managing your e-commerce store.
-
-<img src="/images/spree_admin_dashboard.png" alt="Spree Admin Dashboard" />
-
-## What You Can Do
-
-The Admin Dashboard allows store administrators to manage:
-
-- **Products** - Create and manage products, variants, images, and inventory
-- **Orders** - Process orders, refunds, and shipments
-- **Customers** - View customer accounts and order history
-- **Promotions** - Create discounts, coupon codes, and special offers
-- **Settings** - Configure store settings, shipping, taxes, and payments
-
-## Customization Options
-
-As a developer, you can fully customize the Admin Dashboard:
-
-
-  - [Add New Sections](../tutorial/admin.md) — Create entirely new admin pages for custom features like Brands, Vendors, or any custom model
-  - [Extend Existing UI](extending-ui.md) — Inject custom fields, buttons, and sections into existing admin pages
-  - [Custom Navigation](navigation.md) — Add menu items to the sidebar or create custom navigation structures
-  - [Custom Styling](custom-css.md) — Add your own CSS to match your brand or modify the look and feel
-
-
-## Architecture Overview
-
-Spree Admin follows standard Rails conventions with some Spree-specific patterns:
-
-```
-app/
-├── controllers/
-│   └── spree/
-│       └── admin/
-│           └── products_controller.rb    # Your custom controllers
-├── views/
-│   └── spree/
-│       └── admin/
-│           └── products/
-│               ├── index.html.erb        # List view
-│               ├── _form.html.erb        # Shared form partial
-│               └── _table_row.html.erb   # Table row partial
-├── helpers/
-│   └── spree/
-│       └── admin/
-│           └── products_helper.rb        # View helpers
-└── assets/
-    └── tailwind/
-        └── spree_admin.css               # Custom Tailwind styles
-```
-
-## Key Concepts
-
-### Controllers
-
-Admin controllers inherit from `Spree::Admin::ResourceController` which provides:
-
-- Full CRUD operations (index, new, create, edit, update, destroy)
-- Automatic authorization checks
-- Flash messages and redirects
-- Search and filtering with Ransack
-
-```ruby
-# app/controllers/spree/admin/brands_controller.rb
-module Spree
-  module Admin
-    class BrandsController < ResourceController
-      # That's it! CRUD is handled automatically.
-      # Override methods only when needed.
-    end
-  end
-end
-```
-
-> **INFO:** Learn more about creating admin sections in the [Admin Dashboard Tutorial](../tutorial/admin.md).
-
-### Views & Templates
-
-Views use standard Rails ERB templates with Spree's [Form Builder](form-builder.md) and [Components](components.md):
-
-```erb
-<%# app/views/spree/admin/brands/_form.html.erb %>
-<div class="card mb-6">
-  <div class="card-header">
-    <h5 class="card-title"><%= Spree.t(:general_settings) %></h5>
-  </div>
-  <div class="card-body">
-    <%= f.spree_text_field :name, required: true %>
-    <%= f.spree_text_area :description %>
-    <%= f.spree_file_field :logo, width: 300, height: 300 %>
-    <%= f.spree_check_box :active %>
-  </div>
-</div>
-```
-
-### JavaScript & Interactivity
-
-Spree Admin uses [Hotwire](https://hotwire.dev/) (Turbo + Stimulus) for interactivity:
-
-- **Turbo Drive** - Fast page navigation without full reloads
-- **Turbo Frames** - Update parts of the page independently
-- **Turbo Streams** - Real-time updates over WebSocket
-- **Stimulus** - Lightweight JavaScript controllers
-
-```erb
-<%# Using Stimulus controllers %>
-<div data-controller="dropdown">
-  <button data-action="dropdown#toggle">Menu</button>
-  <div data-dropdown-target="menu">...</div>
-</div>
-```
-
-> **INFO:** Add custom JavaScript using [Stimulus controllers](custom-javascript.md).
-
-### Styling
-
-The Admin Dashboard uses [Tailwind CSS v4](https://tailwindcss.com/) for styling. You can:
-
-- Use Tailwind utility classes directly in your views
-- Override theme variables (colors, spacing, typography)
-- Add custom components using `@layer components`
-
-```erb
-<%# Using Tailwind utility classes in views %>
-<div class="bg-white rounded-lg shadow-sm border border-zinc-200 p-4">
-  <h3 class="text-lg font-bold text-zinc-900">My Custom Card</h3>
-  <p class="text-sm text-zinc-600 mt-2">Card content here</p>
-</div>
-```
-
-> **INFO:** Learn how to customize styles in [Custom CSS](custom-css.md).
-
-## Quick Reference
-
-### Available Tools
-
-| Tool | Purpose | Documentation |
-|------|---------|---------------|
-| Form Builder | Create consistent forms with validation | [Form Builder](form-builder.md) |
-| Components | Dropdowns, dialogs, icons, badges, etc. | [Components](components.md) |
-| Helper Methods | Navigation, links, utilities | [Helper Methods](helper-methods.md) |
-| UI Extensions | Inject content into existing pages | [Extending UI](extending-ui.md) |
-
-### Common Tasks
-
-| Task | How To |
-|------|--------|
-| Add a new admin page | Use the scaffold generator: `bin/rails g spree:admin:scaffold Spree::Brand` |
-| Add sidebar navigation | Use `Spree.admin.navigation.sidebar.add` in an initializer |
-| Add form fields | Use `f.spree_text_field`, `f.spree_select`, etc. |
-| Show flash messages | They're automatic with `ResourceController` |
-| Check permissions | Use `can?(:update, @product)` in views |
-
-### Generator Commands
-
-
-```bash Spree CLI (Docker)
-# Generate a complete admin section (controller, views, routes)
-spree generate spree:admin:scaffold Spree::Brand
-
-# Generate just a controller
-spree generate controller Spree::Admin::Brands --skip-routes
-```
-
-```bash Without Spree CLI
-# Generate a complete admin section (controller, views, routes)
-bin/rails g spree:admin:scaffold Spree::Brand
-
-# Generate just a controller
-bin/rails g controller Spree::Admin::Brands --skip-routes
-```
-
-
-## Authentication & Authorization
-
-### Authentication
-
-Admin users must be authenticated to access the dashboard. Spree supports:
-
-- Built-in Devise authentication
-- Custom authentication adapters
-- SSO integration
-
-> **INFO:** See [Authentication](authentication.md) for setup details.
-
-### Authorization
-
-Spree uses [CanCanCan](https://github.com/CanCanCommunity/cancancan) for authorization:
-
-```ruby
-# Check permissions in controllers
-authorize! :update, @product
-
-# Check permissions in views
-<% if can?(:destroy, @product) %>
-  <%= link_to_delete(@product) %>
-<% end %>
-```
-
-> **INFO:** See [Permissions](../customization/permissions.md) for defining custom abilities.
-
-## Next Steps
-
-
-  - [Tutorial: Build Admin UI](../tutorial/admin.md) — Step-by-step guide to creating a complete admin section
-  - [Form Builder](form-builder.md) — Learn all available form field helpers
-  - [Components](components.md) — Explore UI components like dropdowns, dialogs, and icons
-  - [Extending UI](extending-ui.md) — Add custom content to existing admin pages

package/dist/developer/admin/authentication.md

@@ -1,59 +0,0 @@
----
-title: Admin Panel Authentication
-sidebarTitle: Authentication
-description: How to customize the Spree admin panel authentication
----
-
-Spree allows you to use a different model for the admin panel than the storefront (that's the default since Spree 5.2).
-Here you can find how to customize the admin panel authentication to use a different model.
-
-Let's assume you have an existing `AdminUser` model in your application and you're using Devise for authentication.
-
-In `config/initializers/spree.rb` file, add the following line:
-
-```ruby
-Spree.admin_user_class = 'AdminUser'
-```
-
-This will tell Spree to use your `AdminUser` model for the admin panel. You will also need to add the following line in that model file:
-
-```ruby
-include Spree::UserMethods
-```
-
-In your `config/initializers/routes.rb` file, you will need to define devise routes for the 2nd model:
-
-```ruby
-Spree::Core::Engine.routes.prepend_routes do
-  # Admin authentication
-  devise_for(
-    Spree.admin_user_class.model_name.singular_route_key,
-    class_name: Spree.admin_user_class.to_s,
-    controllers: {
-      sessions: 'spree/admin/user_sessions',
-      passwords: 'spree/admin/user_passwords'
-    },
-    skip: :registrations,
-    path: :admin_user,
-    router_name: :spree
-  )
-end
-```
-
-And now in your `lib/spree/authentication_helpers.rb` file, please replace the following lines: 
-
-```diff
-     def spree_admin_login_path(opts = {})
--      spree_login_path(opts)
-+      new_admin_user_session_path(opts)
-     end
-
-     def spree_admin_logout_path(opts = {})
--      spree_logout_path(opts)
-+      destroy_admin_user_session_path(opts)
-     end
-```
-
-Now when attempting to access the admin panel, you will be redirected to the dedicated admin panel login page.
-
-![Admin panel login page](/images/developer/admin/admin_panel_login.png)