Skip to content

armgit / spree

Public Imported from GitHub
0

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

docs: improve SEO descriptions across CLI 2.0 doc pages (#14143)

mintlify[bot]6f6b5054ef4b
diff --git a/docs/api-reference/store-api/errors.mdx b/docs/api-reference/store-api/errors.mdx
index ba70921240..1914f7820f 100644
--- a/docs/api-reference/store-api/errors.mdx
+++ b/docs/api-reference/store-api/errors.mdx
@@ -1,6 +1,6 @@
---
title: Errors
-description: Error response format, error codes, and handling strategies
+description: Reference for Spree Store API error responses — JSON format, machine-readable codes, HTTP status codes, validation details, and retry strategies.
---
The Store API uses a consistent, Stripe-style error format across all endpoints. Every error response includes a machine-readable `code` and a human-readable `message`.
diff --git a/docs/api-reference/store-api/idempotency.mdx b/docs/api-reference/store-api/idempotency.mdx
index 86dff449f0..f9282bb0e1 100644
--- a/docs/api-reference/store-api/idempotency.mdx
+++ b/docs/api-reference/store-api/idempotency.mdx
@@ -1,7 +1,7 @@
---
title: "Idempotency"
sidebarTitle: "Idempotency"
-description: "Prevent duplicate operations with idempotency keys"
+description: "Use Idempotency-Key headers on Spree Store API mutations to safely retry carts, checkouts, and payments without creating duplicate side effects."
---
The Store API supports idempotency keys on mutating endpoints. This lets you safely retry requests without risking duplicate side effects — for example, adding an item to cart twice or creating duplicate payments due to network timeouts.
diff --git a/docs/developer/cli/quickstart.mdx b/docs/developer/cli/quickstart.mdx
index 773f80ff8f..3a0544b3cf 100644
--- a/docs/developer/cli/quickstart.mdx
+++ b/docs/developer/cli/quickstart.mdx
@@ -1,7 +1,7 @@
---
title: Spree CLI
sidebarTitle: Overview
-description: Manage your Spree Commerce project from the command line.
+description: Install and use the @spree/cli to scaffold, run, build, migrate, and upgrade Docker-based Spree Commerce projects from the command line.
---
The Spree CLI (`@spree/cli`) manages Docker-based Spree projects created with [create-spree-app](/developer/create-spree-app/quickstart).
diff --git a/docs/developer/contributing/creating-an-extension.mdx b/docs/developer/contributing/creating-an-extension.mdx
index 38a4b61ed1..e14da10fee 100644
--- a/docs/developer/contributing/creating-an-extension.mdx
+++ b/docs/developer/contributing/creating-an-extension.mdx
@@ -1,6 +1,6 @@
---
title: Creating an Extension
-description: Learn how to create a Spree extension.
+description: Step-by-step guide to building a Spree extension gem — scaffolding, decorators, migrations, assets, and packaging for distribution.
---
## Overview
diff --git a/docs/developer/contributing/developing-spree.mdx b/docs/developer/contributing/developing-spree.mdx
index e93b295723..6c06a141f5 100644
--- a/docs/developer/contributing/developing-spree.mdx
+++ b/docs/developer/contributing/developing-spree.mdx
@@ -1,8 +1,6 @@
---
title: Developing Spree
-description: >-
- This guide covers all the necessary steps to contributing to Spree source
- code. We're happy you're here!
+description: Set up a Spree development environment with Docker, run the test suite, and submit pull requests to contribute to the Spree Commerce source code.
---
Please read our [Code of Conduct](https://github.com/spree/spree/blob/main/CODE_OF_CONDUCT.md) before contributing.
diff --git a/docs/developer/core-concepts/addresses.mdx b/docs/developer/core-concepts/addresses.mdx
index d0e070867d..c65268f985 100644
--- a/docs/developer/core-concepts/addresses.mdx
+++ b/docs/developer/core-concepts/addresses.mdx
@@ -1,6 +1,6 @@
---
title: Addresses
-description: Addresses, countries, states, and zones — how geography drives checkout, taxes, and shipping
+description: How Spree models addresses, countries, states, and zones, and how geographic data drives checkout, tax calculation, and shipping rates.
---
## Overview
diff --git a/docs/developer/core-concepts/adjustments.mdx b/docs/developer/core-concepts/adjustments.mdx
index 36341a8980..851e8775bf 100644
--- a/docs/developer/core-concepts/adjustments.mdx
+++ b/docs/developer/core-concepts/adjustments.mdx
@@ -1,6 +1,6 @@
---
title: Adjustments
-description: How taxes, promotions, and other price modifications are applied to orders
+description: How Spree adjustments apply taxes, promotions, and other price modifications to orders, line items, and shipments, and how totals are recalculated.
---
## Overview
diff --git a/docs/developer/core-concepts/customers.mdx b/docs/developer/core-concepts/customers.mdx
index 4736275d0c..dd32c7691e 100644
--- a/docs/developer/core-concepts/customers.mdx
+++ b/docs/developer/core-concepts/customers.mdx
@@ -1,6 +1,6 @@
---
title: Customers
-description: Customer accounts — registration, authentication, profiles, and guest checkout
+description: How Spree models customer accounts — registration, authentication, addresses, order history, store credits, and guest checkout behavior.
---
import { Since } from '/snippets/since.mdx';
diff --git a/docs/developer/core-concepts/events.mdx b/docs/developer/core-concepts/events.mdx
index fdc98f1b57..300c6629c1 100644
--- a/docs/developer/core-concepts/events.mdx
+++ b/docs/developer/core-concepts/events.mdx
@@ -1,6 +1,6 @@
---
title: Events
-description: Learn how Spree's event system works and how to subscribe to events.
+description: Spree's event system — publish and subscribe to lifecycle events from orders, products, and users to trigger background jobs and integrations.
---
import { Since } from '/snippets/since.mdx';
diff --git a/docs/developer/core-concepts/markets.mdx b/docs/developer/core-concepts/markets.mdx
index dc4f29342d..ce21e405b9 100644
--- a/docs/developer/core-concepts/markets.mdx
+++ b/docs/developer/core-concepts/markets.mdx
@@ -1,6 +1,6 @@
---
title: Markets
-description: Multi-region commerce with Markets — bundle geography, currency, and locale into distinct selling regions within a single store.
+description: Configure Spree Markets to bundle geography, currency, and locale into distinct selling regions and run multi-region commerce from a single store.
---
import { Since } from '/snippets/since.mdx';
diff --git a/docs/developer/core-concepts/media.mdx b/docs/developer/core-concepts/media.mdx
index 65899cf113..752db93a01 100644
--- a/docs/developer/core-concepts/media.mdx
+++ b/docs/developer/core-concepts/media.mdx
@@ -1,7 +1,7 @@
---
title: Media
sidebarTitle: "Media"
-description: Product media (images, videos), named variants, focal points, and how media is served via the Store API
+description: Manage product media in Spree — images, videos, named variants, focal points, and how media is uploaded, resized, and served via the Store API.
---
import { Since } from '/snippets/since.mdx';
diff --git a/docs/developer/core-concepts/orders.mdx b/docs/developer/core-concepts/orders.mdx
index a973716f0b..33a37f302f 100644
--- a/docs/developer/core-concepts/orders.mdx
+++ b/docs/developer/core-concepts/orders.mdx
@@ -1,6 +1,6 @@
---
title: Orders
-description: Order lifecycle, checkout flow, line items, payments, and shipments
+description: How Spree models orders — the cart-to-completion lifecycle, checkout state machine, line items, payments, shipments, and order totals.
---
## Overview
diff --git a/docs/developer/core-concepts/promotions.mdx b/docs/developer/core-concepts/promotions.mdx
index 3e42c2cc30..389744bc65 100644
--- a/docs/developer/core-concepts/promotions.mdx
+++ b/docs/developer/core-concepts/promotions.mdx
@@ -1,6 +1,6 @@
---
title: Promotions
-description: Learn about Spree's flexible promotion system for discounts, free shipping, and gifts.
+description: Build percentage and fixed-amount discounts, free shipping, BOGO offers, and coupon codes with Spree's rule and action-based promotion system.
---
## Overview
diff --git a/docs/developer/core-concepts/search-filtering.mdx b/docs/developer/core-concepts/search-filtering.mdx
index f044ba5eed..b0b3330c01 100644
--- a/docs/developer/core-concepts/search-filtering.mdx
+++ b/docs/developer/core-concepts/search-filtering.mdx
@@ -1,6 +1,6 @@
---
title: Search & Filtering
-description: "Search, filter, and sort products and other resources via the Store API"
+description: "Use Ransack-style query parameters to search, filter, sort, and paginate products, taxons, and other resources through the Spree Store API."
---
import { Since } from '/snippets/since.mdx';
diff --git a/docs/developer/core-concepts/shipments.mdx b/docs/developer/core-concepts/shipments.mdx
index cae546a421..556bdac74b 100644
--- a/docs/developer/core-concepts/shipments.mdx
+++ b/docs/developer/core-concepts/shipments.mdx
@@ -1,6 +1,6 @@
---
title: Shipments
-description: Shipping methods, rates, split shipments, and fulfillment
+description: How Spree models shipments, shipping methods, calculators, stock locations, split shipments, and the fulfillment workflow from order to delivery.
---
import { Since } from '/snippets/since.mdx';
diff --git a/docs/developer/core-concepts/stores.mdx b/docs/developer/core-concepts/stores.mdx
index 8889cdcfd6..77a2b4d9cd 100644
--- a/docs/developer/core-concepts/stores.mdx
+++ b/docs/developer/core-concepts/stores.mdx
@@ -1,6 +1,6 @@
---
title: Stores
-description: The Store is Spree's top-level tenant — products, orders, channels, markets, and stock locations all belong to exactly one store.
+description: The Store is Spree's top-level multi-tenant boundary — learn how products, orders, channels, markets, and stock locations are scoped to a store.
---
## Overview
diff --git a/docs/developer/core-concepts/translations.mdx b/docs/developer/core-concepts/translations.mdx
index 92ea620691..b05c39d147 100644
--- a/docs/developer/core-concepts/translations.mdx
+++ b/docs/developer/core-concepts/translations.mdx
@@ -1,6 +1,6 @@
---
title: Translations
-description: Translate product content and other resources into multiple languages
+description: Translate Spree products, taxons, and other store content into multiple languages using Mobility-backed translations and locale-aware APIs.
---
## Overview
diff --git a/docs/developer/core-concepts/users.mdx b/docs/developer/core-concepts/users.mdx
index eb72b94e98..8be7a9544e 100644
--- a/docs/developer/core-concepts/users.mdx
+++ b/docs/developer/core-concepts/users.mdx
@@ -1,6 +1,6 @@
---
title: Users
-description: Customers and admin users — authentication, accounts, and permissions
+description: How Spree models customer and admin users — Devise authentication, account data, roles, abilities, and access permissions across stores.
---
## Overview
diff --git a/docs/developer/create-spree-app/quickstart.mdx b/docs/developer/create-spree-app/quickstart.mdx
index 8eb98bdbb2..1204a06d59 100644
--- a/docs/developer/create-spree-app/quickstart.mdx
+++ b/docs/developer/create-spree-app/quickstart.mdx
@@ -1,7 +1,7 @@
---
title: "create-spree-app"
sidebarTitle: Overview
-description: "Scaffold a new Spree Commerce project with a single command. Includes a full Rails backend app for customization."
+description: "Scaffold a new Spree Commerce project with a single command — bootstraps a full Rails backend, Docker dev stack, and the @spree/cli for customization."
---
## Quick Start
diff --git a/docs/developer/customization/checkout.mdx b/docs/developer/customization/checkout.mdx
index 2e38a2fd88..abce1e31d0 100644
--- a/docs/developer/customization/checkout.mdx
+++ b/docs/developer/customization/checkout.mdx
@@ -1,6 +1,6 @@
---
title: Checkout Flow
-description: Learn how to customize the checkout process in Spree.
+description: Customize the Spree checkout flow with the checkout DSL — add, remove, or conditionally skip address, delivery, payment, and confirmation steps.
version: v5
---
diff --git a/docs/developer/customization/decorators.mdx b/docs/developer/customization/decorators.mdx
index 7215e8b24e..d942bd9625 100644
--- a/docs/developer/customization/decorators.mdx
+++ b/docs/developer/customization/decorators.mdx
@@ -1,6 +1,6 @@
---
title: Decorators
-description: Decorators allow you to add or modify behavior of Spree classes in your application.
+description: Use Spree decorators to add or modify behavior on core models, controllers, and helpers without forking the gem — patterns, file layout, and pitfalls.
---
<Warning>
diff --git a/docs/developer/customization/quickstart.mdx b/docs/developer/customization/quickstart.mdx
index ae55242dde..9891877682 100644
--- a/docs/developer/customization/quickstart.mdx
+++ b/docs/developer/customization/quickstart.mdx
@@ -1,7 +1,7 @@
---
title: Quickstart
og:title: Spree Customization Quickstart
-description: Learn how to customize every part of the Spree stack
+description: Recommended ways to customize Spree — store settings, configuration, events, webhooks, dependencies, admin extensions, and decorators as a last resort.
---
Spree is a flexible platform allowing you to customize every part of it to suit your business needs. This guide presents customization options **in order of recommendation** - start from the top and only move down if simpler options don't meet your needs.
diff --git a/docs/developer/deployment/environment_variables.mdx b/docs/developer/deployment/environment_variables.mdx
index 9083e37195..d08ff2f48b 100644
--- a/docs/developer/deployment/environment_variables.mdx
+++ b/docs/developer/deployment/environment_variables.mdx
@@ -1,5 +1,6 @@
---
title: Environment Variables
+description: Reference for Spree deployment environment variables — database, Redis, SMTP, web server, file storage, and application configuration settings.
---
Spree uses environment variables for all deployment configuration. No secrets or credentials are stored in the codebase.
diff --git a/docs/developer/sdk/store/markets.mdx b/docs/developer/sdk/store/markets.mdx
index da13544f87..5674ee6129 100644
--- a/docs/developer/sdk/store/markets.mdx
+++ b/docs/developer/sdk/store/markets.mdx
@@ -1,6 +1,6 @@
---
title: Markets
-description: Fetch markets, resolve by country, and list market countries with the Spree SDK
+description: Use the Spree Storefront SDK to list markets, resolve a market by country, and fetch the countries available within each market for checkout.
---
## List Markets
diff --git a/docs/developer/tutorial/extending-models.mdx b/docs/developer/tutorial/extending-models.mdx
index a659caa302..8ebce76d31 100644
--- a/docs/developer/tutorial/extending-models.mdx
+++ b/docs/developer/tutorial/extending-models.mdx
@@ -1,6 +1,6 @@
---
title: Extending Core Models
-description: Learn how to extend Spree's core models to connect Brands with Products
+description: Tutorial — extend Spree's core models with a custom Brand resource, generate a migration, and associate it with Products via a decorator.
---
In this tutorial, we'll connect our custom Brand model with Spree's core Product model. This is a common pattern when building features that need to integrate with existing Spree functionality.