feat: documents (SWF-286)

.changeset/metal-countries-train.md

@@ -0,0 +1,5 @@
+---
+"vue-demo-store": minor
+---
+
+Add documents to the order summary

apps/docs/src/best-practices/error-handling/api-client-error-handling.md

@@ -23,14 +23,16 @@ There is an `errorInterceptor` (see [axios interceptors](https://axios-http.com/
 When there is an error returend from a request you can expect at least the following fields: `message`, `code` and `errors` (containing an array with one or multiple `ShopwareError` objects). You can find the type definition at `packages/types/shopware-6-client/errors/ApiError.d.ts`.
 
 ### Structure
+
 Let's say we want to use the `getCustomerRegisterEndpoint` which points to `/store-api/account/register`. These function is used inside the `customerService` by an async function called `register` and returning a promise with an Customer object. Further the `register` function is used inside a composable called `useUser()`. There is also a function called `register` that is wrapping the `register` function from the API client. When you now look at the `register.vue` page inside the vue-demo-store implementation, you will see, that the submit of the form is invoked.
 
-__So the way is like this:__  
+**So the way is like this:**  
 API client Endpoint (TS) **>** API client Service (TS) **>** Composable (TS) **>** Vue
 
 ## Example (Vue page/template)
 
 Look at this `invokeSubmit` function from `templates/vue-demo-store/pages/register.vue`
+
 ```js
 <script setup lang="ts">
     const { register } = useUser();
@@ -58,7 +60,8 @@ Look at this `invokeSubmit` function from `templates/vue-demo-store/pages/regist
     //... content reduced
 </script>
 ```
-Before some request is sent the form get's validated and if it is valid, we will send the register request. The `await register(state);` part is coming from the composable `useUser()`, you see at the top of the script setup.  So the request is surrounded by a try/catch/finally (see also [axios errors handling](https://axios-http.com/docs/handling_errors)) so it is possible to react if there is some error coming back from the request. If we got an error we will push a message to a composable called `useNotifications()` that will display a nice message to the user of the website. 
+
+Before some request is sent the form get's validated and if it is valid, we will send the register request. The `await register(state);` part is coming from the composable `useUser()`, you see at the top of the script setup. So the request is surrounded by a try/catch/finally (see also [axios errors handling](https://axios-http.com/docs/handling_errors)) so it is possible to react if there is some error coming back from the request. If we got an error we will push a message to a composable called `useNotifications()` that will display a nice message to the user of the website.
 
 **API Client Reference**
-<PageRef page="../../packages/api-client" title="API Client Reference" sub="Package reference with all services" />
+<PageRef page="../../packages/api-client" title="API Client Reference" sub="Package reference with all services" />

apps/docs/src/packages/api-client/addCartItems.md

@@ -5,5 +5,3 @@ category: api-client
 # addCartItems
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/addProductReview.md

@@ -5,5 +5,3 @@ category: api-client
 # addProductReview
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/addProductToCart.md

@@ -5,4 +5,3 @@ category: api-client
 # addProductToCart
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-

apps/docs/src/packages/api-client/addPromotionCode.md

@@ -5,5 +5,3 @@ category: api-client
 # addPromotionCode
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/addWishlistProduct.md

@@ -5,5 +5,3 @@ category: api-client
 # addWishlistProduct
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/cancelOrder.md

@@ -5,5 +5,3 @@ category: api-client
 # cancelOrder
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/changeCartItemQuantity.md

@@ -5,5 +5,3 @@ category: api-client
 # changeCartItemQuantity
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/changeOrderPaymentMethod.md

@@ -5,5 +5,3 @@ category: api-client
 # changeOrderPaymentMethod
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/clearCart.md

@@ -5,5 +5,3 @@ category: api-client
 # clearCart
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/config.md

@@ -5,5 +5,3 @@ category: api-client
 # config
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/confirmAccountRegistration.md

@@ -5,5 +5,3 @@ category: api-client
 # confirmAccountRegistration
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/confirmPasswordReset.md

@@ -5,5 +5,3 @@ category: api-client
 # confirmPasswordReset
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/createCustomerAddress.md

@@ -5,5 +5,3 @@ category: api-client
 # createCustomerAddress
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/createInstance.md

@@ -5,5 +5,3 @@ category: api-client
 # createInstance
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/createOrder.md

@@ -5,5 +5,3 @@ category: api-client
 # createOrder
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/deleteCustomerAddress.md

@@ -5,5 +5,3 @@ category: api-client
 # deleteCustomerAddress
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getAddWishlistProductEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getAddWishlistProductEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getAvailableCountries.md

@@ -5,5 +5,3 @@ category: api-client
 # getAvailableCountries
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getAvailableCurrencies.md

@@ -5,5 +5,3 @@ category: api-client
 # getAvailableCurrencies
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getAvailableLanguages.md

@@ -5,5 +5,3 @@ category: api-client
 # getAvailableLanguages
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getAvailablePaymentMethods.md

@@ -5,5 +5,3 @@ category: api-client
 # getAvailablePaymentMethods
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getAvailableSalutations.md

@@ -5,5 +5,3 @@ category: api-client
 # getAvailableSalutations
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getAvailableShippingMethods.md

@@ -5,5 +5,3 @@ category: api-client
 # getAvailableShippingMethods
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCancelOrderEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getCancelOrderEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCart.md

@@ -5,5 +5,3 @@ category: api-client
 # getCart
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCategories.md

@@ -5,5 +5,3 @@ category: api-client
 # getCategories
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCategory.md

@@ -5,5 +5,3 @@ category: api-client
 # getCategory
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCategoryDetailsEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getCategoryDetailsEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCategoryEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getCategoryEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCategoryProducts.md

@@ -5,5 +5,3 @@ category: api-client
 # getCategoryProducts
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getChangeOrderPaymentMethodEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getChangeOrderPaymentMethodEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCheckoutCartEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getCheckoutCartEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCheckoutCartLineItemEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getCheckoutCartLineItemEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCheckoutOrderEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getCheckoutOrderEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCmsPage.md

@@ -5,5 +5,3 @@ category: api-client
 # getCmsPage
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getConfirmPasswordResetEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getConfirmPasswordResetEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getContactFormEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getContactFormEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getContextCountryEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getContextCountryEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getContextCurrencyEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getContextCurrencyEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getContextEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getContextEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getContextLanguageEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getContextLanguageEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getContextPaymentMethodEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getContextPaymentMethodEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getContextSalutationEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getContextSalutationEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getContextShippingMethodEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getContextShippingMethodEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCustomer.md

@@ -5,5 +5,3 @@ category: api-client
 # getCustomer
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCustomerAccountConfirmEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getCustomerAccountConfirmEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCustomerAddAddressEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getCustomerAddAddressEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCustomerAddress.md

@@ -5,5 +5,3 @@ category: api-client
 # getCustomerAddress
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCustomerAddressEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getCustomerAddressEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCustomerAddresses.md

@@ -5,5 +5,3 @@ category: api-client
 # getCustomerAddresses
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCustomerDefaultBillingAddressEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getCustomerDefaultBillingAddressEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCustomerDefaultShippingAddressEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getCustomerDefaultShippingAddressEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCustomerDetailsUpdateEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getCustomerDetailsUpdateEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCustomerEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getCustomerEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCustomerLoginEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getCustomerLoginEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCustomerLogoutEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getCustomerLogoutEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCustomerOrderEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getCustomerOrderEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCustomerOrders.md

@@ -5,5 +5,3 @@ category: api-client
 # getCustomerOrders
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCustomerRegisterEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getCustomerRegisterEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-

apps/docs/src/packages/api-client/getCustomerResetPasswordEndpoint.md

@@ -5,5 +5,3 @@ category: api-client
 # getCustomerResetPasswordEndpoint
 
 <!-- PLACEHOLDER_DESCRIPTION -->
-
-