@graphcommerce/docs 6.2.0-canary.95 → 6.2.0-canary.97

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 6.2.0-canary.97
+
+## 6.2.0-canary.96
+
 ## 6.2.0-canary.95
 
 ## 6.2.0-canary.94

package/feature-list.md

@@ -158,7 +158,8 @@ Features taken from the Magento Commerce 2 Feature List
 - [ ] Control which products and categories can be viewed by each customer
       group. — [Commerce]
 - [ ] Show side-by-side product comparisons with two or more products. — [Todo]
-- [ ] Display recently viewed and compared products. — [Todo]
+- [ ] Display recently viewed products. — [Todo]
+- [x] Compare products. — [Enhanced]
 - [x] Increase search relevancy and scalability with Elasticsearch technology.
 - [x] Set stop words, attribute weightings, and search synonyms for higher
       conversions.

package/hygraph/dynamic-rows.md

@@ -7,7 +7,7 @@ the category. Let's take a deeper look.
 
 > Note
 >
-> The Dynamic Row functionality is available since Graphcommerce 6.2.
+> The Dynamic Row functionality is available since Graphcommerce 7.0.0
 
 ## Example of injecting a Dynamic Row
 
@@ -17,7 +17,7 @@ after the product specs:
 
 1. We name the Dynamic Row `discount-banner-row`
 2. The row we want to inject. In this case the row `discount-banner`.
-   ![Row to insert](row-to-insert.png)
+   ![row-to-insert](https://github.com/graphcommerce-org/graphcommerce/assets/1244416/5cada894-daef-45ef-bbb9-0ddedca0ecf5)
 3. We set the placement on `AFTER`
 4. The placement target will be `product-specs`
 5. For the conditions we will use the `Text` and `Number` components nested in
@@ -25,7 +25,7 @@ after the product specs:
 
 The result is as follows:
 
-![Dynamic row fields](dynamic-row-fields.png)
+![dynamic-row-fields](https://github.com/graphcommerce-org/graphcommerce/assets/1244416/d3f26e9e-0ad0-4713-86a8-67f2fa2b6a97)
 
 The Dynamic Row should now be injected on all the pages whose properties match
 the conditions.

package/magento/configurable-products.md

@@ -20,75 +20,66 @@ updates for the following data:
   selected, but this only happens when the actual variant can be accessed via
   the URL.
 
-## Enabling this Feature
+## Displaying the configured variant on a configurable product page for a simple product
 
-To enable this feature, add the **configurableVariantValues** section to your
-`graphcommerce.config.js` file and activate the desired options.
+Add the following to your `graphcommerce.config.js` file:
 
-```
-const config = {
-  ...
+Determines whether a simple product should appear as a Configurable Product with
+pre-selected options or as the default Simple Product.
 
-  configurableVariantValues: {
-    url: true,
-    gallery: true,
-    content: true,
-  },
+### How does this work?
 
+When the `products(filters: { url_key: { eq: 'simple-product' } }) { ... }`
+query is ran, Magento also returns besides the requested Simple product also the
+Configurable product the simple belongs to.
+
+If that is the case we render the Configurable Product page instead of the
+Simple Product page, but the options for the Simple Product are pre-selected.
+
+```js
+const config = {
   configurableVariantForSimple: true,
 }
+module.exports = config
 ```
 
-### GraphCommerceConfig
-
-- #### `configurableVariantForSimple: Boolean`
-
-  Determines whether a simple product should appear as a Configurable Product
-  with pre-selected options or as the default Simple Product.
-
-  **How does this work:**
-
-  When the `products(filters: { url_key: { eq: 'simple-product' } }) { ... }`
-  query is ran, Magento also returns the Simple product and the Configurable
-  product the simple belongs to.
+## Switching content when a variant is selected
 
-  If that is the case we render the Configurable Product page instead of the
-  Simple Product page but the options to select the Simple Product are
-  pre-selected.
+Add the following to your `graphcommerce.config.js` file:
 
-- #### `configurableVariantValues`
+- `url`: When a variant is selected the URL of the product will be changed in
+  the address bar. Note that this only occurs when the actual variant can be
+  accessed through the URL.
 
-  Options to configure which values will be replaced when a variant is selected
-  on the product page.
+- `content`: Use the name, description, short description and meta data from the
+  configured variant
 
-  - #### `content: Boolean`
+- `gallery`: This option enables the automatic update of product gallery images
+  on the product page when a variant is selected, provided that the gallery
+  images for the selected variant differ from the currently displayed images.
 
-    **Description:** Use the name, description, short description and meta data
-    from the configured variant
-
-  - #### `gallery: Boolean`
-
-    **Description:** This option enables the automatic update of product gallery
-    images on the product page when a variant is selected, provided that the
-    gallery images for the selected variant differ from the currently displayed
-    images.
-
-  - #### `url: Boolean`
-
-    **Description:** When a variant is selected the URL of the product will be
-    changed in the address bar.
-
-    **Note:** This only occurs when the actual variant can be accessed through
-    the URL.
+```js
+const config = {
+  configurableVariantValues: {
+    url: true,
+    gallery: true,
+    content: true,
+  },
+}
+```
 
 ## Magento configuration
 
-### How should a Magento administrator configure the configurable and simple products to use this?
+### How to configure the simple and configurable products to use this feature?
+
+By default Magento will return the simple and configurable for a simple variant,
+no configuration required.
 
-To make use of this features the Visibility of your product should be set to
-**Catalog** or **Catalog, Search**. Or else the data is not accessible.
+To make the automatic swithcing of URL's possible, make sure the simple product
+has a URL by making sure it's visibility is set something different than
+`Not Visible Individually`: `Catalog`, `Catalog, Search` or `Search`.
 
-> `Catalog -> Products -> [product] -> Visibility: [Catalog / Catalog, Search]`
+`Catalog -> Products -> [product] -> Visibility: [Catalog / Catalog, Search / Search]`
 
 ## Next steps
 

package/package.json

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

package/roadmap.md

@@ -13,19 +13,28 @@ menu: Roadmap
 The following overview contains the status of items on the GraphCommerce roadmap
 (items are subject to change):
 
-## In progress
+## In progress / planned
 
-- [ ] Better authorization handling
-- [ ] Hygraph schema migrations
-- [ ] Edge runtime for GraphQL Mesh and Streaming SSR rendering
 - [ ] Global store messages
+- [ ] Wishlist redesign
+- [ ] Success page redesign
+- [ ] Product thumbnails on product page
+- [ ] Dutch Postcode API upgrades
+- [ ] Invalid session handling improvements
+- [ ] Performance improvements
+- [ ] Migration to next/image in favor of @graphcommerce/image
 
-## Just released
+## Released
 
 [See all releases](https://github.com/graphcommerce-org/graphcommerce/releases?q=prerelease%3Afalse+&expanded=true)
 
+- [x] Configurable variants for simple products
+      [ocs ↗](https://graphcommerce.org/docs/magento/configurable-products)
+- [x] Cart redesign
+- [x] Hygraph schema migrations
+      [docs ↗](https://graphcommerce.org/docs/hygraph/cli)
 - [x] [Algolia Search (beta)](https://github.com/graphcommerce-org/graphcommerce/tree/main/packages/algolia-search)
-- [x] [Dynamic Rows (beta)](https://github.com/graphcommerce-org/graphcommerce/tree/main/packages/hygraph-dynamic-rows)
+- [x] [Dynamic Rows](https://github.com/graphcommerce-org/graphcommerce/tree/main/packages/hygraph-dynamic-rows)
 - [x] [Product compare](https://github.com/graphcommerce-org/graphcommerce/blob/main/packages/magento-compare/Config.graphqls)
 - [x] Google Tagmanager 4 datalayer implementation
       [docs ↗](https://github.com/graphcommerce-org/graphcommerce/tree/main/packages/googleanalytics)
@@ -51,20 +60,16 @@ The following overview contains the status of items on the GraphCommerce roadmap
 - [x] Checkout payment selection rebuild
 - [x] Core stability (hydratation, caching, query optimization)
 
-## Planned
-
-- [ ] Redesigned cart
-- [ ] Product thumbnail carousel
-- [ ] React Server Components integration
-
 ## Future
 
-- [ ] Fetch Magento image sizes (probe-image-size)
+- [ ] React Server Components integration
+- [ ] Edge runtime for GraphQL Mesh
 - [ ] Windows support
 - [ ] Store locator
 - [ ] Buckaroo payment service
 - [ ] `magento` example without Hygraph
 - [ ] PageBuilder support
+      [depends on ↗](https://github.com/magento/magento2/issues/37768)
 
 ## Next steps