docs: publish restructure (#3496)

* docs: added features and guides overview page * added image * added version 2 * added version 3 * added version 4 * docs: implemented new color scheme * docs: redesigned sidebar (#3193) * docs: redesigned navbar for restructure (#3199) * docs: redesigned footer (#3209) * docs: redesigned cards (#3230) * docs: redesigned admonitions (#3231) * docs: redesign announcement bar (#3236) * docs: redesigned large cards (#3239) * docs: redesigned code blocks (#3253) * docs: redesigned search modal and page (#3264) * docs: redesigned doc footer (#3268) * docs: added new sidebars + refactored css and assets (#3279) * docs: redesigned api reference sidebar * docs: refactored css * docs: added code tabs transition * docs: added new sidebars * removed unused assets * remove unusued assets * Fix deploy errors * fix incorrect link * docs: fixed code responsivity + missing icons (#3283) * docs: changed icons (#3296) * docs: design fixes to the sidebar (#3297) * redesign fixes * docs: small design fixes * docs: several design fixes after restructure (#3299) * docs: bordered icon fixes * docs: desgin fixes * fixes to code blocks and sidebar scroll * design adjustments * docs: restructured homepage (#3305) * docs: restructured homepage * design fixes * fixed core concepts icon * docs: added core concepts page (#3318) * docs: restructured homepage * design fixes * docs: added core concepts page * changed text of different components * docs: added architecture link * added missing prop for user guide * docs: added regions overview page (#3327) * docs: added regions overview * moved region pages to new structure * docs: fixed description of regions architecture page * small changes * small fix * docs: added customers overview page (#3331) * docs: added regions overview * moved region pages to new structure * docs: fixed description of regions architecture page * small changes * small fix * docs: added customers overview page * fix link * resolve link issues * docs: updated regions architecture image * docs: second-iteration fixes (#3347) * docs: redesigned document * design fixes * docs: added products overview page (#3354) * docs: added carts overview page (#3363) * docs: added orders overview (#3364) * docs: added orders overview * added links in overview * docs: added vercel redirects * docs: added soon badge for cards (#3389) * docs: resolved feedback changes + organized troubleshooting pages (#3409) * docs: resolved feedback changes * added extra line * docs: changed icons for restructure (#3421) * docs: added taxes overview page (#3422) * docs: added taxes overview page * docs: fix sidebar label * added link to taxes overview page * fixed link * docs: fixed sidebar scroll (#3429) * docs: added discounts overview (#3432) * docs: added discounts overview * fixed links * docs: added gift cards overview (#3433) * docs: added price lists overview page (#3440) * docs: added price lists overview page * fixed links * docs: added sales channels overview page (#3441) * docs: added sales overview page * fixed links * docs: added users overview (#3443) * docs: fixed sidebar border height (#3444) * docs: fixed sidebar border height * fixed svg markup * docs: added possible solutions to feedback component (#3449) * docs: added several overview pages + restructured files (#3463) * docs: added several overview pages * fixed links * docs: added feature flags + PAK overview pages (#3464) * docs: added feature flags + PAK overview pages * fixed links * fix link * fix link * fixed links colors * docs: added strategies overview page (#3468) * docs: automated upgrade guide (#3470) * docs: automated upgrade guide * fixed vercel redirect * docs: restructured files in docs codebase (#3475) * docs: restructured files * docs: fixed eslint exception * docs: finished restructure loose-ends (#3493) * fixed uses of backend * docs: finished loose ends * eslint fixes * fixed links * merged master * added update instructions for v1.7.12
2023-03-16 17:03:10 +02:00
parent f312ce1e0f
commit 1decaa27c7
415 changed files with 12422 additions and 5098 deletions
@@ -0,0 +1,92 @@
+---
+description: 'Actions Required for v4.0.2'
+sidebar_custom_props:
+  iconName: 'react'
+---
+
+# Medusa React: v4.0.2
+
+Version 4.0.2 of Medusa React introduces a new update in its dependencies which can lead to breaking changes.
+
+## Overview
+
+Medusa React previously required installing React Query v3 as a peer dependency. This version changes the peer dependency requirement to [Tanstack Query](https://tanstack.com/query/latest/docs/react/overview) - the updated version of React Query.
+
+This requires additional actions related to installing the new dependency and changing imports.
+
+---
+
+## Actions Required
+
+### Update Medusa Dependencies
+
+To update to the latest version of Medusa React, run the following command in your custom storefront or admin to update both Medusa React and the core package:
+
+```bash npm2yarn
+npm install medusa-react@latest @medusajs/medusa@latest
+```
+
+### Uninstall React Query v3
+
+As React Query v3 is not required as a peer dependency anymore, uninstall it from your custom storefront or admin:
+
+```bash npm2yarn
+npm uninstall react-query
+```
+
+### Install Tanstack Query
+
+Run the following command to install Tanstack Query:
+
+```bash npm2yarn
+npm install @tanstack/react-query
+```
+
+### Update Imports
+
+Across your custom storefront or admin project, change all imports from `react-query` to `@tanstack/react-query`.
+
+For example, update the import for `QueryClient` where you use it with Medusa Provider:
+
+```ts
+import { QueryClient } from "@tanstack/react-query"
+
+// this remains the same
+const queryClient = new QueryClient()
+```
+
+### Fix No QueryClient set Errors
+
+If you're using a Next.js storefront, you might face the following error after this update when you run your storefront:
+
+```bash
+No QueryClient set
+```
+
+This is due to an issue related to Tanstack Query shipping `esm` modules in its latest versions and how Next.js uses Webpack.
+
+Although in future versions of `medusa-react` this issue will be fixed, you can add the following into `next.config.js` to fix this error:
+
+```js
+const path = require("path")
+
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  // ... other configs
+  webpack: (config, options) => {
+    if (options.isServer) {
+      config.externals = [
+        "@tanstack/react-query", 
+        ...config.externals,
+      ]
+    }
+    const reactQuery = path.resolve(
+      require.resolve("@tanstack/react-query")
+    )
+    config.resolve.alias["@tanstack/react-query"] = reactQuery
+    return config
+  },
+}
+
+module.exports = nextConfig
+```
@@ -0,0 +1,6 @@
+{
+  "position": 2,
+  "collapsed": true,
+  "link": null,
+  "label": "Medusa React"
+}