@spree/docs 0.1.76 → 0.1.77

package/dist/developer/admin/admin.md

@@ -16,7 +16,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 Options

package/dist/developer/admin/extending-ui.md

@@ -944,93 +944,6 @@ Here's a list of all places you can inject your custom code:
 </details>
 
 
-### Post Categories
-
-<details>
-<summary>Post Categories Actions</summary>
-
-`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" %>
-    ```
-
-</details>
-
-
-  <details>
-<summary>Post Categories Header</summary>
-
-`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>
-    ```
-
-</details>
-
-
-### Posts
-
-<details>
-<summary>Posts Actions</summary>
-
-`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" %>
-    ```
-
-</details>
-
-
-  <details>
-<summary>Posts Header</summary>
-
-`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>
-    ```
-
-</details>
-
-
-  <details>
-<summary>Posts Filters</summary>
-
-`posts_filters`
-
-    #### Variables
-
-    - **`f`** (`Spree::Admin::FormBuilder`) — The [Spree::Admin::FormBuilder](form-builder.md) object.
-
-    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](../core-concepts/search-filtering.md) search syntax for filter field names.
-
-</details>
-
-
 ### Promotions
 
 <details>
@@ -1621,38 +1534,6 @@ Here's a list of all places you can inject your custom code:
 </details>
 
 
-### Themes
-
-<details>
-<summary>Themes Actions</summary>
-
-`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" %>
-    ```
-
-</details>
-
-
-  <details>
-<summary>Themes Header</summary>
-
-`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>
-    ```
-
-</details>
-
-
 ### Webhooks Subscribers
 
 <details>

package/dist/developer/admin/tables.md

@@ -432,8 +432,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) |

package/dist/developer/core-concepts/slugs.md

@@ -73,7 +73,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:
 
 
 ```typescript SDK

package/package.json

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

package/dist/developer/contributing/updating-extensions.md

@@ -1,67 +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)

package/dist/developer/customization/v4/admin-panel.md

@@ -1,78 +0,0 @@
-> **WARNING:** This section is only relevant for Spree 4
-
-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.
-
-![](/images/Screenshot 2023-10-31 at 18.57.13.png)
-
-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.

package/dist/developer/customization/v4/authentication.md

@@ -1,210 +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`.
-
-To use your own authentication system with Spree, please follow these steps:
-
-<details>
-<summary>1. Change the Spree.user_class</summary>
-
-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'
-    ```
-
-</details>
-
-
-  <details>
-<summary>2. Update User model</summary>
-
-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.
-
-</details>
-
-  <details>
-<summary>3. Include User concerns in your User model</summary>
-
-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: 'master@example.com')
-    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.
-
-</details>
-
-  <details>
-<summary>4. Customize Spree Authentication Helpers (Optional)</summary>
-
-> **NOTE:** This step is required if you're using **`spree_backend`** and/or `spree_frontend` gems.
-
-    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`.
-
-</details>
-
-  <details>
-<summary>5. Remove Auth Devise gem</summary>
-
-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
-    ```
-
-</details>
-
-
-## 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.