@graphcommerce/docs 5.1.0-canary.1 → 5.1.0-canary.11

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # Change Log
 
+## 5.1.0-canary.11
+
+## 5.1.0-canary.10
+
+## 5.1.0-canary.9
+
+## 5.1.0-canary.8
+
+## 5.1.0-canary.7
+
+## 5.1.0-canary.6
+
+## 5.1.0-canary.5
+
+## 5.1.0-canary.4
+
+### Patch Changes
+
+- [#1755](https://github.com/graphcommerce-org/graphcommerce/pull/1755) [`41fa631b1`](https://github.com/graphcommerce-org/graphcommerce/commit/41fa631b15721625e521772da01fd2c3a2ae82de) - Add a chapter about SEO migration ([@paales](https://github.com/paales))
+
+## 5.1.0-canary.3
+
+### Patch Changes
+
+- [#1752](https://github.com/graphcommerce-org/graphcommerce/pull/1752) [`2a6a4d9ec`](https://github.com/graphcommerce-org/graphcommerce/commit/2a6a4d9ecfa1b58a66ba9b9d00016d6feda9aa95) - Updated dependencies to latest versions, except for nextjs; Solve tons of peer dependency issues.
+
+  - Updated the @mui/material package
+  - Removed dependencies on react-hook-form-mui and @playwright/test
+  - Upgraded dependencies including type-fest and graphql-mesh
+  - Solved peer dependency issues ([@paales](https://github.com/paales))
+
+## 5.1.0-canary.2
+
 ## 5.1.0-canary.1
 
 ## 5.1.0-canary.0

package/contributing.md

@@ -59,6 +59,7 @@ File structure of GraphCommerce
 GraphCommerce uses ESLint for linting and Prettier for code formatting. Install
 the [recommended VS Code extensions](../docs/getting-started/vscode.md)
 
+<!--
 ### Contributor License Agreement
 
 Please make sure you have signed our Contributor License Agreement. We are not
@@ -66,6 +67,13 @@ asking you to assign copyright to us, but to give us the right to distribute
 your code without restriction. We ask this of all contributors in order to
 assure our users of the origin and continuing existence of the code. You only
 need to sign the CLA once.
+-->
+
+### Creating a branch
+
+1. Fork the repository and clone it locally.
+2. Create a branch for your PR based on the `canary` branch. Use the following
+   naming convention: `feature/your-branch-name` or `fix/your-branch-name`
 
 ### Creating a pull request
 
@@ -73,14 +81,14 @@ need to sign the CLA once.
 2. Add your changes
 3. Add a changeset
 
-- Run 'yarn changeset' and select minor bump. Commit the changeset that is
-  created.
+- Run 'yarn changeset' and select 'patch' for bugfixes and 'minor' for new
+  features. Commit the changeset that is created.
 
 <figure>
 
 ![yarn changeset](https://user-images.githubusercontent.com/1251986/157868337-0fa27e88-cf35-4e38-a59c-72c72ef6b054.jpg)
 
-  <figcaption>Select minor bump when running `yarn changeset`</figcaption>
+  <figcaption>Select 'patch' or 'minor' when running `yarn changeset`</figcaption>
 </figure>
 
 ## Next steps

package/magento/seo-migration.md

@@ -0,0 +1,34 @@
+# SEO Migration
+
+GraphCommerce uses a different URL structure than default Magento to achieve
+better performance.
+
+## How are routes handled?
+
+- Products have a different URL structure: `/p/[url]`. e.g.
+  `/p/my-product-url-key`.
+- Categories use same URL structure: `/[...url]`. e.g. `/my/category/path`.
+
+- GraphCommerce does not use any URL suffixes. e.g. `.html`.
+
+## Why doesn't GraphCommerce support full URL rewrites?
+
+GraphCommerce splits the loaded JavaScript into route specific bundles improves
+performance. This means that the products and categories (and checkout) all have
+their own JavaScript bundle.
+
+To load the page the user is visiting as fast as possibble, we directly need to
+know what type of route we are viewing (e.g. `/p/[url]` or `/[...url]`).
+
+We don't believe this is a problem for SEO. Most of the big platforms use
+similar structure to do this. (amazon.com, apple.com, wallmart.com, target.com,
+otto.de, etc.)
+
+## How do I migrate my SEO URLs?
+
+A permanent redirect for product URLs to the `/p/[url]` is made automatically.
+
+A permanent redirect for product and category paths ending in the configured
+suffix (e.g. `.html`) is made automatically.
+
+Categories use the same URL structure as Magento, no redirection there.

package/package.json

@@ -2,10 +2,10 @@
   "name": "@graphcommerce/docs",
   "homepage": "https://www.graphcommerce.org/docs",
   "repository": "github:graphcommerce-org/graphcommerce/docs",
-  "version": "5.1.0-canary.1",
+  "version": "5.1.0-canary.11",
   "sideEffects": true,
   "devDependencies": {
-    "@graphcommerce/prettier-config-pwa": "^5.1.0-canary.1"
+    "@graphcommerce/prettier-config-pwa": "5.1.0-canary.11"
   },
   "prettier": "@graphcommerce/prettier-config-pwa"
 }