@spree/docs 0.1.59 → 0.1.61

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.
@@ -8,7 +8,7 @@ import { Since } from '/snippets/since.mdx';
8
8
 
9
9
  > **WARNING:** **Developer Preview.** The Admin API is in active development and may change between major versions.
10
10
 
11
- The Admin API is a REST API for managing a Spree stores programmatically — products, orders, customers, fulfillments, payments, and more. It is intended for backend integrations, custom admin tooling, and automation.
11
+ The Admin API is a REST API for managing Spree stores programmatically — products, orders, customers, fulfillments, payments, and more. It is intended for backend integrations, custom admin tooling, and automation.
12
12
 
13
13
  All routes are prefixed with `/api/v3/admin`. During development the API is available under `http://localhost:3000/api/v3/admin`. For production, replace `http://localhost:3000` with your Spree application URL.
14
14
 
@@ -312,7 +312,7 @@ New RESTful design allows to implement different usage scenarios like multiple s
312
312
 
313
313
  #### Session-based payments (Stripe, Adyen, PayPal)
314
314
 
315
- API v2 had per-gateway endpoints (`/stripe/payment_intents`, `/adyen/payment_sessions`). API v3 unifies these behind a generic [Payment Sessions API](../../developer/core-concepts/payments.md#session-based-flow-stripe-adyen-paypal-etc) — the gateway-specific payload moves into the request body, and Spree dispatches to the right provider based on the `payment_method_id`. This shortens the integration time and allows team to deliver payment integrations faster. Also your frontend code don't need to change per gateway.
315
+ API v2 had per-gateway endpoints (`/stripe/payment_intents`, `/adyen/payment_sessions`). API v3 unifies these behind a generic [Payment Sessions API](../../developer/core-concepts/payments.md#session-based-flow-stripe-adyen-paypal-etc) — the gateway-specific payload moves into the request body, and Spree dispatches to the right provider based on the `payment_method_id`. This shortens the integration time and allows team to deliver payment integrations faster. Also your frontend code doesn't need to change per gateway.
316
316
 
317
317
  | Storefront API v2 | Store API v3 |
318
318
  |---|---|
@@ -163,7 +163,7 @@ Use the resultCode to inform your shopper about the current payment status.
163
163
  Possible resultCode values:
164
164
  - `authorised` - payment authorised
165
165
  - `refused` - payment refused
166
- - `pending` - payment pending (for payments with asynchronous flow like iDEAL). When the shopper completes the payment webhook will process process the payment.
166
+ - `pending` - payment pending (for payments with asynchronous flow like iDEAL). When the shopper completes the payment webhook will process the payment.
167
167
  - `cancelled` - payment canceled
168
168
  - `received` - some payments needs more time to be processed. When the status is available webhook will process the payment
169
169
  - `error` - an error occurred when processing the payment. The response contains more details with the error code
@@ -17,6 +17,6 @@ Currently Spree includes 2 modern REST APIs:
17
17
 
18
18
  ## Thank you!
19
19
 
20
- Give Spree a [GitHub Star](https://github.com/spree/spree), why dont't ya? Thank you for supporting Spree open-source!
20
+ Give Spree a [GitHub Star](https://github.com/spree/spree), why don't ya? Thank you for supporting Spree open-source!
21
21
 
22
22
  Need support or want to give some feedback? Join our [Discord](https://discord.spreecommerce.org/)
@@ -87,6 +87,6 @@ Upon successful authentication, you should see the admin screen:
87
87
 
88
88
  Congrats! You've set up your Spree Commerce and it's looking amazing!
89
89
 
90
- Give Spree a [GitHub Star](https://github.com/spree/spree), why dont't ya? Thank you for supporting Spree open-source!
90
+ Give Spree a [GitHub Star](https://github.com/spree/spree), why don't ya? Thank you for supporting Spree open-source!
91
91
 
92
92
  Need support or want to give some feedback? Join our [Discord](https://discord.spreecommerce.org/)
@@ -14,7 +14,7 @@ Go to your domain name in Cloudflare and click on "Caching" tab and select "Cach
14
14
 
15
15
  ![Cloudflare Cache Rules](/images/developer/deployment/cloudflare_caching.png)
16
16
 
17
- Click on "Create Rule" and setup the rule as bellow:
17
+ Click on "Create Rule" and setup the rule as below:
18
18
 
19
19
  ![Cloudflare Cache Rule Settings](/images/developer/deployment/cloudflare_cache_rule_1.png)
20
20
 
@@ -32,7 +32,7 @@ and the second value with
32
32
 
33
33
  This will handle caching of both images and static files such as JavaScript and CSS files.
34
34
 
35
- Now scroll down and set the settings as bellow:
35
+ Now scroll down and set the settings as below:
36
36
 
37
37
  ![Cloudflare Cache Rule Settings](/images/developer/deployment/cloudflare_cache_rule_2.png)
38
38
 
@@ -77,6 +77,6 @@ Upon successful authentication, you should see the admin screen:
77
77
 
78
78
  Congrats! You've set up your Spree Commerce and it's looking amazing!
79
79
 
80
- Give Spree a [GitHub Star](https://github.com/spree/spree), why dont't ya? Thank you for supporting Spree open-source!
80
+ Give Spree a [GitHub Star](https://github.com/spree/spree), why don't ya? Thank you for supporting Spree open-source!
81
81
 
82
82
  Need support or want to give some feedback? Join our [Discord](https://discord.spreecommerce.org/)
@@ -53,7 +53,7 @@ This will render a WYSIWYG editor to the brand description field in the Admin da
53
53
 
54
54
  ## Step 3: Update permitted parameters in controller
55
55
 
56
- To permit the `description` attribute to be saved, we need to update the permitted parameters in the controller. file and add the following code:
56
+ To permit the `description` attribute to be saved, we need to update the permitted parameters in the controller file and add the following code:
57
57
 
58
58
  ```ruby app/controllers/spree/admin/brands_controller.rb {9}
59
59
  module Spree
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@spree/docs",
3
- "version": "0.1.59",
3
+ "version": "0.1.61",
4
4
  "description": "Spree Commerce developer documentation for AI agents and local reference",
5
5
  "type": "module",
6
6
  "license": "CC-BY-4.0",