@spree/docs 0.1.237 → 0.1.239

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.
Files changed (46) hide show
  1. package/dist/api-reference/webhooks-events.md +1 -1
  2. package/dist/developer/contributing/developing-spree.md +2 -2
  3. package/dist/developer/core-concepts/catalogs.md +5 -1
  4. package/dist/developer/core-concepts/metafields.md +1 -1
  5. package/dist/developer/core-concepts/store-credits-gift-cards.md +3 -5
  6. package/dist/developer/core-concepts/stores.md +1 -1
  7. package/dist/developer/customization/configuration.md +8 -8
  8. package/dist/developer/customization/dependencies.md +9 -9
  9. package/dist/developer/customization/metadata.md +3 -3
  10. package/dist/developer/customization/quickstart.md +7 -7
  11. package/dist/developer/customization/validations.md +1 -1
  12. package/dist/developer/dashboard/customization/backend.md +7 -4
  13. package/dist/developer/dashboard/customization/navigation.md +5 -3
  14. package/dist/developer/dashboard/customization/permissions.md +3 -1
  15. package/dist/developer/dashboard/customization/quickstart.md +3 -4
  16. package/dist/developer/dashboard/customization/routes.md +7 -6
  17. package/dist/developer/dashboard/customization/slots.md +7 -6
  18. package/dist/developer/dashboard/customization/tables.md +4 -2
  19. package/dist/developer/dashboard/customization/translations.md +4 -2
  20. package/dist/developer/dashboard/overview.md +5 -4
  21. package/dist/developer/dashboard/public-api.md +16 -2
  22. package/dist/developer/dashboard/recipes/attribute-end-to-end.md +2 -3
  23. package/dist/developer/dashboard/recipes/custom-form-field.md +12 -6
  24. package/dist/developer/dashboard/recipes/page-action-button.md +9 -8
  25. package/dist/developer/dashboard/recipes/sidebar-widget.md +11 -5
  26. package/dist/developer/dashboard/slots-catalog.md +1 -1
  27. package/dist/developer/how-to/build-a-marketplace.md +3 -3
  28. package/dist/developer/how-to/custom-digital-asset-provider.md +1 -1
  29. package/dist/developer/how-to/custom-document-numbers.md +3 -3
  30. package/dist/developer/how-to/custom-promotion.md +1 -1
  31. package/dist/developer/how-to/sell-digital-products.md +1 -1
  32. package/dist/developer/providers/dam.md +3 -1
  33. package/dist/developer/providers/erp.md +3 -1
  34. package/dist/developer/providers/pim.md +3 -1
  35. package/dist/developer/providers/sso.md +1 -1
  36. package/dist/developer/tutorial/dashboard.md +307 -0
  37. package/dist/developer/tutorial/events.md +66 -6
  38. package/dist/developer/tutorial/introduction.md +42 -13
  39. package/dist/developer/tutorial/model-and-api.md +187 -0
  40. package/dist/developer/tutorial/storefront.md +123 -6
  41. package/dist/developer/tutorial/testing.md +163 -7
  42. package/package.json +1 -1
  43. package/dist/developer/tutorial/admin-api.md +0 -13
  44. package/dist/developer/tutorial/dashboard-plugin.md +0 -14
  45. package/dist/developer/tutorial/model.md +0 -13
  46. package/dist/developer/tutorial/store-api.md +0 -13
@@ -1,13 +0,0 @@
1
- ---
2
- title: Admin API
3
- description: Add a ProductFaq endpoint to the Admin API — resource controller conventions, an admin serializer, and a permission catalog entry.
4
- ---
5
-
6
- Staff manage FAQs through the Admin API — the same API the dashboard, integrations and scripts use. This chapter adds the endpoint following the conventions every Spree resource follows, which is what makes the dashboard plugin in the next chapter nearly free.
7
-
8
- ## What this chapter covers
9
-
10
- - The resource controller: full CRUD from one small controller declaring its model, serializer and permitted attributes
11
- - The admin serializer and prefixed IDs
12
- - Registering the resource in the permission catalog so roles and API key scopes cover it
13
- - Exercising the endpoint with the Admin CLI
@@ -1,14 +0,0 @@
1
- ---
2
- title: Dashboard Plugin
3
- description: Scaffold a dashboard plugin for ProductFaqs — a table, a form, and navigation, generated by the CLI and wired to the Admin API endpoint.
4
- ---
5
-
6
- With the Admin API in place, the back-office UI is a dashboard plugin: a table listing FAQs, a form to create and edit them, and a navigation entry — scaffolded by the CLI and customized from there.
7
-
8
- ## What this chapter covers
9
-
10
- - Scaffolding the plugin with the CLI
11
- - The resource table: columns, search and pagination against the Admin API
12
- - The form: fields, validation errors mapped from API responses
13
- - Registering navigation and permissions-aware visibility
14
- - Running it against your development store
@@ -1,13 +0,0 @@
1
- ---
2
- title: Model
3
- description: Generate the ProductFaq model — migration, associations, validations and store scoping — the foundation both tracks build on.
4
- ---
5
-
6
- Every feature starts with a model. This chapter generates `ProductFaq` — question, answer, position, attached to a product and scoped to the store.
7
-
8
- ## What this chapter covers
9
-
10
- - Generating the model and migration from the command line
11
- - Store scoping — why every store-owned record belongs to a store, and what that buys you
12
- - The association to products, validations, and ordering
13
- - Running the migration and creating a record in the console
@@ -1,13 +0,0 @@
1
- ---
2
- title: Store API
3
- description: Expose FAQs to customers — a read-only Store API endpoint with a serializer that shows only what shoppers should see.
4
- ---
5
-
6
- Customers read FAQs through the Store API. This chapter adds the customer-facing endpoint — read-only, scoped to the current store, with a serializer deliberately smaller than the admin one.
7
-
8
- ## What this chapter covers
9
-
10
- - The store resource controller: read-only by default, and why
11
- - The store serializer: public fields only — no timestamps, no internal data
12
- - Scoping: only FAQs for purchasable products of the current store
13
- - Nesting under the product endpoint