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 titles for SDK and tutorial pages (#14153)

mintlify[bot]09d2db0d4847
diff --git a/docs/developer/sdk/admin/authentication.mdx b/docs/developer/sdk/admin/authentication.mdx
index c49285c830..4cb07132c1 100644
--- a/docs/developer/sdk/admin/authentication.mdx
+++ b/docs/developer/sdk/admin/authentication.mdx
@@ -1,6 +1,7 @@
---
-title: "Authentication"
-description: "Authenticate the Admin SDK with a secret API key (server-to-server, scope-based) or JWT cookie auth (browser admin apps, role-based)."
+title: "Admin SDK authentication with API keys and JWT cookies"
+sidebarTitle: "Authentication"
+description: "Authenticate @spree/admin-sdk with a secret API key for server-to-server, scope-based access or JWT cookie auth for role-based browser admin apps."
---
The Admin API supports two authentication methods. Both reach the same endpoints — they differ in **where the credential lives** and **how authorization is decided**:
diff --git a/docs/developer/sdk/admin/querying-and-errors.mdx b/docs/developer/sdk/admin/querying-and-errors.mdx
index e5d36c5b7c..268a85bb6c 100644
--- a/docs/developer/sdk/admin/querying-and-errors.mdx
+++ b/docs/developer/sdk/admin/querying-and-errors.mdx
@@ -1,6 +1,7 @@
---
-title: "Querying & Errors"
-description: "Filter, sort, paginate, and expand Admin API collections with flat Ransack parameters — and handle structured SpreeError responses."
+title: "Filtering, pagination, and error handling in the Admin SDK"
+sidebarTitle: "Querying & Errors"
+description: "Filter, sort, paginate, and expand Admin API collections with flat Ransack parameters and handle structured SpreeError responses from @spree/admin-sdk."
---
## Filtering
diff --git a/docs/developer/sdk/admin/quickstart.mdx b/docs/developer/sdk/admin/quickstart.mdx
index 2e011d2b7b..56f8979203 100644
--- a/docs/developer/sdk/admin/quickstart.mdx
+++ b/docs/developer/sdk/admin/quickstart.mdx
@@ -1,7 +1,7 @@
---
-title: "Admin SDK"
+title: "Admin SDK quickstart for @spree/admin-sdk"
sidebarTitle: Quickstart
-description: "Manage your store programmatically with @spree/admin-sdk — the official TypeScript client for the Spree Admin API v3."
+description: "Install and configure @spree/admin-sdk, the official TypeScript client for the Spree Admin API v3, to manage products, orders, customers, and stock."
---
[`@spree/admin-sdk`](https://www.npmjs.com/package/@spree/admin-sdk) is the official TypeScript SDK for the [Admin API v3](/api-reference/admin-api/introduction) — the back-office counterpart to [`@spree/sdk`](/developer/sdk/quickstart). Use it to build integrations, automations, internal tools, and custom admin UIs: manage products, orders, customers, stock, promotions, webhooks, and more.
diff --git a/docs/developer/sdk/admin/resources.mdx b/docs/developer/sdk/admin/resources.mdx
index 16fbe16049..f420a71736 100644
--- a/docs/developer/sdk/admin/resources.mdx
+++ b/docs/developer/sdk/admin/resources.mdx
@@ -1,6 +1,7 @@
---
-title: "Resources"
-description: "The full @spree/admin-sdk resource map — products, orders, customers, inventory, pricing, promotions, store configuration, and platform resources."
+title: "Admin SDK resources and CRUD client methods"
+sidebarTitle: "Resources"
+description: "Reference for every @spree/admin-sdk resource — products, orders, customers, inventory, pricing, promotions, store configuration, and platform clients."
---
Every Admin API resource is exposed as a property on the client (`client.orders`, `client.products`, …). Collection resources follow a consistent CRUD shape — `list`, `get`, `create`, `update`, `delete` — plus resource-specific actions. Nested resources take the **parent ID as the first argument**:
diff --git a/docs/developer/sdk/quickstart.mdx b/docs/developer/sdk/quickstart.mdx
index e58c60f8de..f8bf6076ee 100644
--- a/docs/developer/sdk/quickstart.mdx
+++ b/docs/developer/sdk/quickstart.mdx
@@ -1,6 +1,7 @@
---
-title: Quickstart
-description: Install the Spree TypeScript SDK, configure your Store API client, and make your first calls to products, carts, checkout, and customer endpoints.
+title: Spree TypeScript SDK quickstart for the Store API
+sidebarTitle: Quickstart
+description: Install @spree/sdk, configure the Store API client, and make your first calls to products, carts, checkout, and customer account endpoints from TypeScript.
---
`@spree/sdk` is the customer-facing SDK — products, carts, checkout, and account flows against the Store API. For back-office integrations (managing products, orders, customers, stock), use the [Admin SDK](/developer/sdk/admin/quickstart).
diff --git a/docs/developer/tutorial/api.mdx b/docs/developer/tutorial/api.mdx
index 9264e0de82..e6117c01cd 100644
--- a/docs/developer/tutorial/api.mdx
+++ b/docs/developer/tutorial/api.mdx
@@ -1,5 +1,6 @@
---
-title: API
+title: Expose a custom model through the Store and Admin APIs
+sidebarTitle: API
description: Expose your custom Brand model through the Spree Store and Admin REST APIs with serializers, controllers, routes, and the spree:api_resource generator.
---