@spree/docs 0.1.290 → 0.1.292

package/dist/developer/create-spree-app/quickstart.md

@@ -18,7 +18,7 @@ The CLI walks you through an interactive setup:
 
 Once complete, your store is running at [http://localhost:3000](http://localhost:3000) — setup pulls the latest Spree image, seeds the database, and configures API keys, then prints a summary with your admin credentials and keys. If you skipped starting services, the first `pnpm dev` completes setup automatically.
 
-The **dashboard** and the marketplace **seller panel** are included in every project — there is no flag to add them.
+The **admin dashboard** is included in every project (skip it with `--no-dashboard` and the API still serves the built-in one at `/dashboard`). The installer asks whether to add the **seller panel** — a dedicated panel where marketplace vendors manage their products, orders and settings. Answer yes only if you run a marketplace; you can add it later with `spree add seller-dashboard`.
 
 ## Prerequisites
 
@@ -30,14 +30,14 @@ The **dashboard** and the marketplace **seller panel** are included in every pro
 All prompts can be skipped with flags for non-interactive (CI/CD) usage:
 
 ```bash
-npx create-spree-app@latest my-store --no-storefront --no-sample-data --no-start
+npx create-spree-app@latest my-store --no-seller-dashboard --no-storefront --no-start
 ```
 
 | Flag | Description |
 |------|-------------|
-| `--react-dashboard` | No-op — the dashboard is always included. Kept so existing scripts keep working |
+| `--no-dashboard` | Skip the admin dashboard app — the API still serves the built-in one at `/dashboard` |
+| `--no-seller-dashboard` | Skip the marketplace seller panel |
 | `--no-storefront` | Skip Next.js storefront setup |
-| `--no-sample-data` | Skip loading sample products and categories |
 | `--no-start` | Don't start Docker services after scaffolding |
 | `--port <number>` | Port for the Spree backend (default: `3000`) |
 | `--use-npm` | Use npm as package manager |
@@ -58,9 +58,9 @@ my-store/
 │   ├── Dockerfile            # Also builds the production image (API + dashboard)
 │   └── Gemfile
 ├── apps/
-│   ├── dashboard/            # Admin dashboard (React)
+│   ├── dashboard/            # Admin dashboard (unless --no-dashboard)
 │   │   └── .env.local        # Dev proxy target — no credentials
-│   ├── seller-dashboard/     # Seller panel, for marketplaces (React)
+│   ├── seller-dashboard/     # Seller panel, for marketplaces (unless --no-seller-dashboard)
 │   └── storefront/           # Next.js storefront (unless --no-storefront)
 │       └── .env.local        # API URL + publishable key
 ├── .env                      # SECRET_KEY_BASE, encryption keys, SPREE_PORT, SPREE_VERSION_TAG, SPREE_SAMPLE_DATA
@@ -109,11 +109,12 @@ The project includes [@spree/cli](../cli/quickstart.md) for managing your Spree
 
 | Command | Description |
 |---------|-------------|
-| `spree dev` | Run the app in the foreground — streams logs, Ctrl+C stops it. First run completes setup automatically; co-runs the React Dashboard dev server when `apps/dashboard` exists |
+| `spree dev` | Run the app in the foreground — streams logs, Ctrl+C stops it. First run completes setup automatically; co-runs the Admin Dashboard dev server when `apps/dashboard` exists |
 | `spree stop` | Stop backend services |
 | `spree update` | Pull latest Spree image and restart (runs migrations automatically) |
 | `spree eject` | Switch from prebuilt image to building from `server/` |
-| `spree add dashboard` | Add the React Dashboard to an existing project |
+| `spree add dashboard` | Add the Admin Dashboard to an existing project, to customize it |
+| `spree add seller-dashboard` | Add the marketplace seller panel to an existing project |
 | `spree build --production` | Build the production image — the Spree API plus your dashboard, in one |
 | `spree logs` | View backend logs |
 | `spree logs worker` | View background jobs logs |
@@ -160,7 +161,7 @@ SPREE_VERSION_TAG=5.4
 
 ## Deployment
 
-The project deploys as **one image**: `server/Dockerfile` builds the Spree API together with your React Dashboard (when `apps/dashboard` exists), served same-origin at `/dashboard` — no CORS, no cookie configuration, no second service.
+The project deploys as **one image**: `server/Dockerfile` builds the Spree API together with your Admin Dashboard (when `apps/dashboard` exists), served same-origin at `/dashboard` — no CORS, no cookie configuration, no second service.
 
 - **Render** — the `render.yaml` at the project root is a ready Blueprint: one Docker service built straight from your repo, migrations run on boot.
 - **Anywhere else** — `spree build --production` builds the same image locally; push it to a registry and run it on any Docker host.

package/dist/developer/how-to/custom-delivery-rate-provider.md

@@ -33,6 +33,8 @@ module SpreeAcmeCarrier
     preference :test_mode, :boolean, default: true
 
     def self.integration_group = 'shipping'
+    def self.logo_url = 'https://acme-carrier.example.com/logo.svg'
+    def self.docs_url = 'https://acme-carrier.example.com/docs/spree'
 
     # Called when an admin activates the integration. Returning false blocks
     # activation and shows your message in the dashboard.
@@ -51,6 +53,8 @@ module SpreeAcmeCarrier
 end
 ```
 
+`logo_url` and `docs_url` are optional. They put your logo and a "Setup guide" link on the integration's card under **Settings > Integrations**. Payment methods declare them the same way.
+
 Declare secrets as `:password` preferences. Spree masks them on read and guards the round-trip on write, so an API key never leaves the server in plain text.
 
 ## 2. Implement the provider

package/dist/developer/how-to/custom-payment-method.md

@@ -43,6 +43,24 @@ end
 
 After restarting your server, you can select "MyGateway" when creating a new payment method in the admin panel under **Settings > Payments**.
 
+### Show a logo and setup guide (optional)
+
+Payment providers also appear in the admin dashboard under **Settings > Integrations**. Declare a logo and a link to your setup guide so merchants recognise the provider and know how to connect it:
+
+```ruby app/models/my_gateway.rb
+class MyGateway < Spree::PaymentMethod
+  def self.logo_url
+    'https://my-gateway.example.com/logo.svg'
+  end
+
+  def self.docs_url
+    'https://my-gateway.example.com/docs/spree'
+  end
+end
+```
+
+`logo_url` accepts anything an image tag accepts, including a `data:` URI if you don't want to host the file. Both are optional: without a logo the card shows the provider's first letter, and without a guide the link is hidden. Integrations declare the same two methods — see [custom delivery rate providers](custom-delivery-rate-provider.md).
+
 ## Step 3: Add Payment Session Support
 
 Payment Sessions are the modern, PCI-compliant way to handle payments. Your gateway creates a session with the provider, the frontend collects payment details using the provider's SDK, and Spree records the result.

package/package.json

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