@spree/docs 0.1.86 → 0.1.87
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/developer/agentic/mcp.md +1 -1
- package/dist/developer/agentic/overview.md +1 -1
- package/dist/developer/contributing/developing-spree.md +1 -1
- package/dist/developer/customization/api.md +2 -3
- package/dist/developer/getting-started/quickstart.md +1 -1
- package/dist/developer/sdk/extending.md +1 -1
- package/dist/developer/sdk/quickstart.md +1 -1
- package/dist/developer/tutorial/admin.md +1 -1
- package/dist/developer/tutorial/api.md +1 -1
- package/dist/developer/tutorial/events.md +1 -1
- package/dist/developer/tutorial/introduction.md +1 -1
- package/dist/developer/tutorial/model.md +1 -1
- package/dist/developer/tutorial/sdk.md +1 -1
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Docs MCP Server"
|
|
3
3
|
sidebarTitle: MCP
|
|
4
|
-
description: "Connect
|
|
4
|
+
description: "Connect Claude, Cursor, or any MCP-compatible AI agent to the Spree docs MCP server to search and read the latest documentation while building."
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
Spree hosts a [Model Context Protocol](https://modelcontextprotocol.io) server on top of this documentation. Once connected, your agent can search the docs and read full pages on demand — answering questions from the latest published documentation instead of stale training data.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Agentic Development"
|
|
3
3
|
sidebarTitle: Overview
|
|
4
|
-
description: "Build, customize, and upgrade Spree with AI coding agents
|
|
4
|
+
description: "Build, customize, and upgrade Spree stores with AI coding agents using installable agent skills, a documentation MCP server, and LLM-ready docs."
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
Spree ships first-class tooling for AI-assisted development. Whether you use Claude Code, Cursor, Codex, Copilot, or any other coding agent, your agent can learn Spree's conventions, read the right docs at the right time, and run the project safely.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Developing Spree
|
|
3
|
-
description: Set up a Spree development environment with Docker, run the test suite, and submit pull requests
|
|
3
|
+
description: Set up a Spree Commerce development environment with Docker, run the RSpec test suite, follow coding conventions, and submit pull requests upstream.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
Please read our [Code of Conduct](https://github.com/spree/spree/blob/main/CODE_OF_CONDUCT.md) before contributing.
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: API
|
|
3
|
-
description:
|
|
4
|
-
Add new Store API endpoints and customize existing API responses
|
|
2
|
+
title: Customizing the Spree API
|
|
3
|
+
description: Add new Store API endpoints, customize existing JSON responses with serializer decorators, and extend Spree's REST API to fit your storefront needs.
|
|
5
4
|
---
|
|
6
5
|
|
|
7
6
|
Before you start customizing Spree API endpoints, make sure you reviewed all existing API endpoints in the [Spree API docs](/api-reference).
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Installing Spree"
|
|
3
3
|
sidebarTitle: Installation
|
|
4
|
-
description: "
|
|
4
|
+
description: "Install Spree Commerce locally with Docker or Ruby on Rails, run your first store, and deploy it to production with the official starter template."
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
## Installation options
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Custom Endpoints
|
|
3
3
|
sidebarTitle: Custom Endpoints
|
|
4
|
-
description: Call custom Store API endpoints
|
|
4
|
+
description: Call your own custom Store API endpoints from the Spree TypeScript SDK using the built-in request method, with typed responses and shared auth handling.
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
The client exposes a `request` method — the same function that powers all built-in resources. Use it to call any Store API endpoint, including ones you've added yourself.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Quickstart
|
|
3
|
-
description: Install
|
|
3
|
+
description: Install the Spree TypeScript SDK, configure your Store API client, and make your first calls to products, carts, checkout, and customer endpoints.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
## Installation
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Admin Dashboard
|
|
3
|
-
description: Scaffold the admin UI for Brands
|
|
3
|
+
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.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
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.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: API
|
|
3
|
-
description: Expose your Brand model through the Store and Admin APIs with serializers, controllers, and
|
|
3
|
+
description: Expose your custom Brand model through the Spree Store and Admin REST APIs with serializers, controllers, routes, and the spree:api_resource generator.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
In this tutorial, we'll expose our Brand model through Spree's v3 API — the customer-facing **Store API** that storefronts read from, and the back-office **Admin API** with full CRUD for apps and integrations. We'll also extend the existing Product serializer to include brand data.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Events & Webhooks
|
|
3
|
-
description: React to store activity and connect
|
|
3
|
+
description: React to Spree store activity and connect to external systems like an OMS, warehouse, or ERP using event subscribers, the subscriber generator, and webhooks.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
> **INFO:** This guide assumes you've completed the [Model](model.md) and [API](api.md) tutorials — we'll reuse the Brand serializer created there.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Tutorial
|
|
3
3
|
sidebarTitle: Introduction
|
|
4
|
-
description: Build a complete custom feature — model, admin UI, Store
|
|
4
|
+
description: Build a complete custom Brands feature in Spree — model, admin UI, Store and Admin APIs, events, and TypeScript storefront integration — end to end.
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
This tutorial walks you through creating a complete Spree feature from scratch: a "Brands" feature that lets admins manage [Product](../core-concepts/products.md) brands, exposes them through the Store API, and consumes them from TypeScript.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Model
|
|
3
|
-
description: Create
|
|
3
|
+
description: Create a custom Brand model in Spree with database columns, a rich text description, and an Active Storage logo upload using a single generator command.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
In this step we'll create the `Spree::Brand` model with everything it needs: a `name` column, a rich text `description`, and an uploadable `logo`.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: SDK
|
|
3
|
-
description: Use the TypeScript SDK to consume your custom Brand endpoints
|
|
3
|
+
description: Use the Spree TypeScript SDK to consume your custom Brand endpoints, fetch extended Product data, and surface the new resource in your headless storefront.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
In this tutorial, we'll use the `@spree/sdk` TypeScript SDK to consume the Brand API endpoints we created in the [API tutorial](api.md), and work with the extended Product data that now includes brand information.
|