@graphcommerce/docs 8.0.0 → 8.0.1-canary.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 8.0.1-canary.0
+
+### Patch Changes
+
+- [#2187](https://github.com/graphcommerce-org/graphcommerce/pull/2187) [`6c4cee8`](https://github.com/graphcommerce-org/graphcommerce/commit/6c4cee8469ee4934281bda53ac96aeb5af2f9479) - Make sure the config page can be properly rendered in the docs
+  ([@paales](https://github.com/paales))
+
 ## 8.0.0
 
 ### Minor Changes

package/framework/config.md

@@ -115,12 +115,12 @@ When Magento's StoreConfig adds this value, this can be replaced.
 
 Use compare functionality
 
-#### compareVariant: 'CHECKBOX' | 'ICON' = 'ICON'
+#### compareVariant: CHECKBOX | ICON = `ICON`
 
 By default the compare feature is denoted with a 'compare ICON' (2 arrows facing one another).
 This may be fine for experienced users, but for more clarity it's also possible to present the compare feature as a CHECKBOX accompanied by the 'Compare' label
 
-#### configurableVariantForSimple: boolean = false
+#### configurableVariantForSimple: boolean = `false`
 
 If a simple product is part of a Configurable product page, should the simple product be
 rendered as a configured option of the configurable product page?
@@ -133,19 +133,19 @@ Magento also returns the Simple product and the Configurable product the simple
 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.
 
-#### configurableVariantValues: [MagentoConfigurableVariantValues](#MagentoConfigurableVariantValues) = { content: true, url: true }
+#### configurableVariantValues: [MagentoConfigurableVariantValues](#MagentoConfigurableVariantValues) = `{ content: true, url: true }`
 
 When a user selects a variant, it will switch the values on the configurable page with the values of the configured variant.
 
 Enabling options here will allow switching of those variants.
 
-#### crossSellsHideCartItems: boolean = false
+#### crossSellsHideCartItems: boolean = `false`
 
 Determines if cross sell items should be shown when the user already has the product in their cart. This will result in a product will popping off the screen when you add it to the cart.
 
 Default: 'false'
 
-#### crossSellsRedirectItems: boolean = false
+#### crossSellsRedirectItems: boolean = `false`
 
 Determines if, after adding a cross-sell item to the cart, the user should be redirected to the cross-sell items of the product they just added.
 
@@ -163,7 +163,7 @@ This value should match Magento 2's configuration value for
 
 Debug configuration for GraphCommerce
 
-#### demoMode: boolean = true
+#### demoMode: boolean = `true`
 
 Enables some demo specific code that is probably not useful for a project:
 
@@ -263,7 +263,7 @@ By default GraphCommerce will statically generate all product and category pages
 
 To enable next.js' preview mode, configure the secret you'd like to use.
 
-#### productFiltersLayout: 'DEFAULT' | 'SIDEBAR' = 'DEFAULT'
+#### productFiltersLayout: DEFAULT | SIDEBAR = `DEFAULT`
 
 Layout how the filters are rendered.
 DEFAULT: Will be rendered as horzontal chips on desktop and mobile
@@ -427,6 +427,6 @@ Number of recently viewed products to be stored in localStorage
 
 SidebarGalleryConfig will contain all configuration values for the Sidebar Gallery component.
 
-#### paginationVariant: 'DOTS' | 'THUMBNAILS_BOTTOM'
+#### paginationVariant: DOTS | THUMBNAILS_BOTTOM
 
 Variant used for the pagination

package/hygraph/cli.md

@@ -58,9 +58,9 @@ The following steps are needed to utilize this tool:
    1. Copy the project ID from the URL when logged in
       `https://app.hygraph.com/PROJECT_ID_IS_HERE/master`
    2. Add the project ID to your env file:
-      `GC_HYGRAPH_PROJECT_ID=”{YOUR_PROJECT_ID}”`
+      `GC_HYGRAPH_PROJECT_ID="{YOUR_PROJECT_ID}"`
 4. Add your hygraphManagementApi to your env file like this:
-   `GC_HYGRAPH_MANAGEMENT_API="{YOUR_MANAGEMENT_API}"`
+   1. Copy the Management API URL and add to your env file: `GC_HYGRAPH_MANAGEMENT_API="{YOUR_MANAGEMENT_API}"`
 5. Run `yarn graphcommerce hygraph-migrate`
 6. Select the migration you want to run and press enter.
 7. The migrations should now be applied, check your Hygraph Schema if changes

package/hygraph/property-picker.md

@@ -6,11 +6,9 @@ row to each page. These rules hinge on shared attributes among the pages, with a
 category being a typical example of such an attribute. To enable the Dynamic Row
 UI Extension, follow the installation instructions as below.
 
-> Installation
->
-> [Click here to install the Dynamic Row UI Extension](https://app.hygraph.com/apps/dynamic-row-property-picker/new)
+> Installation: [Click here to install the Dynamic Row UI Extension](https://app.hygraph.com/apps/dynamic-row-property-picker/new)
 
-<img width="1792" alt="image" src="https://github.com/graphcommerce-org/graphcommerce/assets/49681263/3226eedb-e58c-4d3f-9516-14ff6ed56f24">
+<img width="1792" alt="image" src="https://github.com/graphcommerce-org/graphcommerce/assets/49681263/3226eedb-e58c-4d3f-9516-14ff6ed56f24"/>
 
 ## Enabling the Application
 
@@ -18,7 +16,7 @@ Once you click the link and authorize the application, you'll be taken to the
 app's configuration page. On this page, you can switch the application on or off
 as needed.
 
-<img width="1792" alt="image" src="https://github.com/graphcommerce-org/graphcommerce/assets/49681263/ec9b55f6-14f6-466e-8a31-0b893ffe1297">
+<img width="1792" alt="image" src="https://github.com/graphcommerce-org/graphcommerce/assets/49681263/ec9b55f6-14f6-466e-8a31-0b893ffe1297"/>
 
 ## Enabling the field
 
@@ -37,7 +35,7 @@ Replace the existing fields with the new `Property picker` field in the right si
 (it should be under `Slug` and above `Rich text`). While adding the
 `Property picker` field make sure that you make it `required`.
 
-<img width="1792" alt="image" src="https://github.com/graphcommerce-org/graphcommerce/assets/49681263/9206f86d-477c-4eaf-bec6-1648874bee5e">
+<img width="1792" alt="image" src="https://github.com/graphcommerce-org/graphcommerce/assets/49681263/9206f86d-477c-4eaf-bec6-1648874bee5e"/>
 
 ## Start building with your new Dynamic Rows UI!
 

package/package.json

@@ -2,10 +2,10 @@
   "name": "@graphcommerce/docs",
   "homepage": "https://www.graphcommerce.org/docs",
   "repository": "github:graphcommerce-org/graphcommerce/docs",
-  "version": "8.0.0",
+  "version": "8.0.1-canary.0",
   "sideEffects": true,
   "peerDependencies": {
-    "@graphcommerce/prettier-config-pwa": "^8.0.0"
+    "@graphcommerce/prettier-config-pwa": "^8.0.1-canary.0"
   },
   "prettier": "@graphcommerce/prettier-config-pwa"
 }

package/upgrading/graphcommerce-7-to-8.md

@@ -1,4 +1,4 @@
-# Upgrading from GraphCommerce 6 to 7
+# Upgrading from GraphCommerce 7 to 8
 
 Depending on the amounts of customisations you've made, there are some manual
 steps. Please follow the regular [upgrade steps first](./readme.md).