@graphcommerce/docs 9.0.1-canary.0 → 9.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/CHANGELOG.md +19 -92
  2. package/framework/seo.md +1 -1
  3. package/framework/theming.md +5 -4
  4. package/getting-started/improving-core-web-vitals.md +3 -3
  5. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -1,125 +1,52 @@
1
1
  # Change Log
2
2
 
3
- ## 9.0.1-canary.0
3
+ ## 9.0.1
4
4
 
5
5
  ### Patch Changes
6
6
 
7
- - [#2454](https://github.com/graphcommerce-org/graphcommerce/pull/2454) [`0f5267b`](https://github.com/graphcommerce-org/graphcommerce/commit/0f5267b92d8561e20164fe2f078097cb52220726) - Update VSCode guide reference ([@emmanuel-ferdman](https://github.com/emmanuel-ferdman))
7
+ - [#2461](https://github.com/graphcommerce-org/graphcommerce/pull/2461) [`7017b60`](https://github.com/graphcommerce-org/graphcommerce/commit/7017b608eb61097c881103c40701ab4a41197d7a) - Solve issue with documentation parsing markdown files as mdx ([@paales](https://github.com/paales))
8
8
 
9
- ## 9.0.0
10
-
11
- ### Minor Changes
12
-
13
- - [#2439](https://github.com/graphcommerce-org/graphcommerce/pull/2439) [`6061226`](https://github.com/graphcommerce-org/graphcommerce/commit/60612265466e4c508a2d3f478ff679251e7819de) - Moved to serwist for service workers ([@paales](https://github.com/paales))
14
-
15
- - [#2242](https://github.com/graphcommerce-org/graphcommerce/pull/2242) [`a4cce76`](https://github.com/graphcommerce-org/graphcommerce/commit/a4cce76ca37af2bec604e953ada4bb11bd91f55d) - Add option to show an extended version of the pagination component. Configurable via the `productListPaginationVariant` key in your `graphcommerce.config.js`.
9
+ - [#2454](https://github.com/graphcommerce-org/graphcommerce/pull/2454) [`0f5267b`](https://github.com/graphcommerce-org/graphcommerce/commit/0f5267b92d8561e20164fe2f078097cb52220726) - Update VSCode guide reference ([@emmanuel-ferdman](https://github.com/emmanuel-ferdman))
16
10
 
17
- - `COMPACT` means: `< Page X of Y >`
18
- - `EXTENDED` means: `< 1 2 ... [5] ... 10 11 >` ([@FrankHarland](https://github.com/FrankHarland))
11
+ ## 9.0.1-canary.1
19
12
 
20
13
  ### Patch Changes
21
14
 
22
- - [#1984](https://github.com/graphcommerce-org/graphcommerce/pull/1984) [`e05534f`](https://github.com/graphcommerce-org/graphcommerce/commit/e05534fff4990fd584fe401b55b6d9a33934e048) - Added docs about caching. ([@paales](https://github.com/paales))
23
-
24
- - [#2223](https://github.com/graphcommerce-org/graphcommerce/pull/2223) [`7652234`](https://github.com/graphcommerce-org/graphcommerce/commit/7652234e222c3f4d8de3817fe907b5b6925a5493) - Replaced `next-sitemap` with page router based robots.txt & sitemaps. ([@bramvanderholst](https://github.com/bramvanderholst))
25
-
26
- - [#2450](https://github.com/graphcommerce-org/graphcommerce/pull/2450) [`b116d0f`](https://github.com/graphcommerce-org/graphcommerce/commit/b116d0f714d37a4db30b19812ce5a9d2a6372d42) - Added documentation about the Canonical URL and Sitemap handling ([@paales](https://github.com/paales))
27
-
28
- - [#2329](https://github.com/graphcommerce-org/graphcommerce/pull/2329) [`6301fe3`](https://github.com/graphcommerce-org/graphcommerce/commit/6301fe33e73be1a151d0f8290e83418b4b87a738) - Document patch `custom_attributesV2` for null attribute values issue. ([@SimonPrins](https://github.com/SimonPrins))
29
-
30
- - [#2196](https://github.com/graphcommerce-org/graphcommerce/pull/2196) [`84c50e4`](https://github.com/graphcommerce-org/graphcommerce/commit/84c50e49a1a7f154d4a8f4045c37e773e20283ad) - Allow Lingui to use `linguiLocale` with country identifiers like `en-us`, it would always load `en` in this case. Introduced a new `useLocale` hook to use the correct locale string to use in Intl methods. ([@paales](https://github.com/paales))
31
-
32
- - [#2326](https://github.com/graphcommerce-org/graphcommerce/pull/2326) [`1faefa4`](https://github.com/graphcommerce-org/graphcommerce/commit/1faefa424df1f40e0f7d20def7192cf7752f761e) - Create a 'Third-Party Libraries' page that includes further details on tools such as Google Analytics and Google Tag Manager. ([@carlocarels90](https://github.com/carlocarels90))
15
+ - [#2461](https://github.com/graphcommerce-org/graphcommerce/pull/2461) [`7017b60`](https://github.com/graphcommerce-org/graphcommerce/commit/7017b608eb61097c881103c40701ab4a41197d7a) - Solve issue with documentation parsing markdown files as mdx ([@paales](https://github.com/paales))
33
16
 
34
- - [#2247](https://github.com/graphcommerce-org/graphcommerce/pull/2247) [`444e446`](https://github.com/graphcommerce-org/graphcommerce/commit/444e446a218cc9da3defb940a6d5cce0229ff845) - Added clear upgrade instructions for `linguiLocale`. ([@paales](https://github.com/paales))
35
-
36
- - [#2427](https://github.com/graphcommerce-org/graphcommerce/pull/2427) [`d400e53`](https://github.com/graphcommerce-org/graphcommerce/commit/d400e534c89955c99a7ccb4bc8b1a0ae2ae4fbfd) - Added web vitals document ([@paales](https://github.com/paales))
37
-
38
- ## 9.0.0-canary.118
39
-
40
- ## 9.0.0-canary.117
41
-
42
- ## 9.0.0-canary.116
43
-
44
- ## 9.0.0-canary.115
45
-
46
- ## 9.0.0-canary.114
17
+ ## 9.0.1-canary.0
47
18
 
48
19
  ### Patch Changes
49
20
 
50
- - [#2450](https://github.com/graphcommerce-org/graphcommerce/pull/2450) [`b116d0f`](https://github.com/graphcommerce-org/graphcommerce/commit/b116d0f714d37a4db30b19812ce5a9d2a6372d42) - Added documentation about the Canonical URL and Sitemap handling ([@paales](https://github.com/paales))
51
-
52
- ## 9.0.0-canary.113
53
-
54
- ## 9.0.0-canary.112
55
-
56
- ## 9.0.0-canary.111
21
+ - [#2454](https://github.com/graphcommerce-org/graphcommerce/pull/2454) [`0f5267b`](https://github.com/graphcommerce-org/graphcommerce/commit/0f5267b92d8561e20164fe2f078097cb52220726) - Update VSCode guide reference ([@emmanuel-ferdman](https://github.com/emmanuel-ferdman))
57
22
 
58
- ## 9.0.0-canary.110
23
+ ## 9.0.0
59
24
 
60
- ## 9.0.0-canary.109
25
+ ### Major Changes
61
26
 
62
- ## 9.0.0-canary.108
27
+ - [#2439](https://github.com/graphcommerce-org/graphcommerce/pull/2439) [`6061226`](https://github.com/graphcommerce-org/graphcommerce/commit/60612265466e4c508a2d3f478ff679251e7819de) - Moved to [serwist](https://serwist.pages.dev/) for service workers. ([@paales](https://github.com/paales))
63
28
 
64
- ### Patch Changes
29
+ - [#2242](https://github.com/graphcommerce-org/graphcommerce/pull/2242) [`a4cce76`](https://github.com/graphcommerce-org/graphcommerce/commit/a4cce76ca37af2bec604e953ada4bb11bd91f55d) - Add option to show an extended version of the pagination component. Configurable via the `productListPaginationVariant` key in your `graphcommerce.config.js`. `COMPACT` means: `< Page X of Y >` and `EXTENDED` means: `< 1 2 ... [5] ... 10 11 >` ([@FrankHarland](https://github.com/FrankHarland))
65
30
 
66
- - [#2439](https://github.com/graphcommerce-org/graphcommerce/pull/2439) [`6061226`](https://github.com/graphcommerce-org/graphcommerce/commit/60612265466e4c508a2d3f478ff679251e7819de) - Moved to serwist for service workers ([@paales](https://github.com/paales))
31
+ - [#2223](https://github.com/graphcommerce-org/graphcommerce/pull/2223) [`7652234`](https://github.com/graphcommerce-org/graphcommerce/commit/7652234e222c3f4d8de3817fe907b5b6925a5493) - Fully replaced the sitemap and robots.txt generation. We previously relied on next-sitemap to generate the sitemap based on static generated pages. However with bigger shops the SSG woudn't be complete. Full support for multi domain setups. ([@bramvanderholst](https://github.com/bramvanderholst))
67
32
 
68
- ## 9.0.0-canary.107
69
-
70
- ## 9.0.0-canary.106
33
+ ### Minor Changes
71
34
 
72
- ## 9.0.0-canary.105
35
+ - [#2196](https://github.com/graphcommerce-org/graphcommerce/pull/2196) [`84c50e4`](https://github.com/graphcommerce-org/graphcommerce/commit/84c50e49a1a7f154d4a8f4045c37e773e20283ad) - Allow Lingui to use `linguiLocale` with country identifiers like `en-us`, it would always load `en` in this case. Introduced a new `useLocale` hook to use the correct locale string to use in Intl methods. ([@paales](https://github.com/paales))
73
36
 
74
37
  ### Patch Changes
75
38
 
76
- - [#2427](https://github.com/graphcommerce-org/graphcommerce/pull/2427) [`d400e53`](https://github.com/graphcommerce-org/graphcommerce/commit/d400e534c89955c99a7ccb4bc8b1a0ae2ae4fbfd) - Added web vitals document ([@paales](https://github.com/paales))
77
-
78
- ## 9.0.0-canary.104
79
-
80
- ## 9.0.0-canary.103
39
+ - [#1984](https://github.com/graphcommerce-org/graphcommerce/pull/1984) [`e05534f`](https://github.com/graphcommerce-org/graphcommerce/commit/e05534fff4990fd584fe401b55b6d9a33934e048) - Added docs about caching. ([@paales](https://github.com/paales))
81
40
 
82
- ## 9.0.0-canary.62
41
+ - [#2450](https://github.com/graphcommerce-org/graphcommerce/pull/2450) [`b116d0f`](https://github.com/graphcommerce-org/graphcommerce/commit/b116d0f714d37a4db30b19812ce5a9d2a6372d42) - Added documentation about the Canonical URL and Sitemap handling ([@paales](https://github.com/paales))
83
42
 
84
- ### Patch Changes
43
+ - [#2329](https://github.com/graphcommerce-org/graphcommerce/pull/2329) [`6301fe3`](https://github.com/graphcommerce-org/graphcommerce/commit/6301fe33e73be1a151d0f8290e83418b4b87a738) - Document patch `custom_attributesV2` for null attribute values issue. ([@SimonPrins](https://github.com/SimonPrins))
85
44
 
86
45
  - [#2326](https://github.com/graphcommerce-org/graphcommerce/pull/2326) [`1faefa4`](https://github.com/graphcommerce-org/graphcommerce/commit/1faefa424df1f40e0f7d20def7192cf7752f761e) - Create a 'Third-Party Libraries' page that includes further details on tools such as Google Analytics and Google Tag Manager. ([@carlocarels90](https://github.com/carlocarels90))
87
46
 
88
- ## 9.0.0-canary.56
89
-
90
- ### Patch Changes
91
-
92
- - [#2329](https://github.com/graphcommerce-org/graphcommerce/pull/2329) [`6301fe3`](https://github.com/graphcommerce-org/graphcommerce/commit/6301fe33e73be1a151d0f8290e83418b4b87a738) - Document patch custom_attributesV2 for null attribute values issue ([@SimonPrins](https://github.com/SimonPrins))
93
-
94
- ## 8.1.0-canary.41
95
-
96
- ### Patch Changes
97
-
98
- - [#2242](https://github.com/graphcommerce-org/graphcommerce/pull/2242) [`a4cce76`](https://github.com/graphcommerce-org/graphcommerce/commit/a4cce76ca37af2bec604e953ada4bb11bd91f55d) - Add option to show an extended version of the pagination component. Configurable via the "productListPaginationVariant" key in your graphcommerce.config.js COMPACT means: "< Page X of Y >" EXTENDED means: "< 1 2 ... [5] ... 10 11 >" ([@FrankHarland](https://github.com/FrankHarland))
99
-
100
- ## 8.1.0-canary.9
101
-
102
- ### Patch Changes
103
-
104
- - [#2223](https://github.com/graphcommerce-org/graphcommerce/pull/2223) [`7652234`](https://github.com/graphcommerce-org/graphcommerce/commit/7652234e222c3f4d8de3817fe907b5b6925a5493) - Replaced next-sitemap with page router based robots.txt & sitemaps ([@bramvanderholst](https://github.com/bramvanderholst))
105
-
106
- ## 8.1.0-canary.8
107
-
108
- ### Patch Changes
109
-
110
- - [#2247](https://github.com/graphcommerce-org/graphcommerce/pull/2247) [`444e446`](https://github.com/graphcommerce-org/graphcommerce/commit/444e446a218cc9da3defb940a6d5cce0229ff845) - Added clear upgrade instructions for linguiLocale ([@paales](https://github.com/paales))
111
-
112
- ## 8.1.0-canary.6
113
-
114
- ### Patch Changes
115
-
116
- - [#1984](https://github.com/graphcommerce-org/graphcommerce/pull/1984) [`e05534f`](https://github.com/graphcommerce-org/graphcommerce/commit/e05534fff4990fd584fe401b55b6d9a33934e048) - Added docs about caching ([@paales](https://github.com/paales))
117
-
118
- ## 8.0.6-canary.0
119
-
120
- ### Patch Changes
47
+ - [#2247](https://github.com/graphcommerce-org/graphcommerce/pull/2247) [`444e446`](https://github.com/graphcommerce-org/graphcommerce/commit/444e446a218cc9da3defb940a6d5cce0229ff845) - Added clear upgrade instructions for `linguiLocale`. ([@paales](https://github.com/paales))
121
48
 
122
- - [#2196](https://github.com/graphcommerce-org/graphcommerce/pull/2196) [`84c50e4`](https://github.com/graphcommerce-org/graphcommerce/commit/84c50e49a1a7f154d4a8f4045c37e773e20283ad) - Allow Lingui to use linguiLocale with country identifiers like `en-us`, it would always load `en` in this case. Introced a new `useLocale` hook to use the correct locale string to use in Intl methods. ([@paales](https://github.com/paales))
49
+ - [#2427](https://github.com/graphcommerce-org/graphcommerce/pull/2427) [`d400e53`](https://github.com/graphcommerce-org/graphcommerce/commit/d400e534c89955c99a7ccb4bc8b1a0ae2ae4fbfd) - Added web vitals document ([@paales](https://github.com/paales))
123
50
 
124
51
  ## 8.0.2
125
52
 
package/framework/seo.md CHANGED
@@ -23,7 +23,7 @@ We integrated [JSON-LD](https://json-ld.org/) for pages.
23
23
  A
24
24
  [`<JsonLd>`](https://github.com/graphcommerce-org/graphcommerce/blob/main/packages/next-ui/JsonLd/JsonLd.tsx)
25
25
  component provides Json-LD metadata for your pages. See
26
- [<ProductPageJsonLd>](https://github.com/graphcommerce-org/graphcommerce/blob/main/packages/magento-product/components/JsonLdProduct/ProductPageJsonLd.tsx)
26
+ [`<ProductPageJsonLd/>`](https://github.com/graphcommerce-org/graphcommerce/blob/main/packages/magento-product/components/JsonLdProduct/ProductPageJsonLd.tsx)
27
27
  or
28
28
  [`<BreadcrumbJsonLd>`](https://github.com/graphcommerce-org/graphcommerce/blob/main/packages/next-ui/BreadcrumbJsonLd/BreadcrumbJsonLd.tsx)
29
29
  for examples.
package/framework/theming.md CHANGED
@@ -11,9 +11,10 @@ as well as some common theming needs.
11
11
 
12
12
  ## Changing the color palette
13
13
 
14
- The global styles or your GraphCommerce app are located in /components/theme.ts.
15
- To customize the app with your preferred colors, change the primary, secondary
16
- and text colors. Save the file to see your changes updated in real-time:
14
+ The global styles or your GraphCommerce app are located in
15
+ /components/theme.ts.` To customize the app with your preferred colors, change
16
+ the primary, secondary and text colors. Save the file to see your changes
17
+ updated in real-time:
17
18
 
18
19
  ```json
19
20
  primary: {
@@ -248,7 +249,7 @@ should not be scaled with responsiveVal. To learn more, look into
248
249
 
249
250
  ## Disabling darkmode or lightmode site wide
250
251
 
251
- Remove light={lightTheme} or dark={darkTheme} from the
252
+ Remove `light={lightTheme}` or `dark={darkTheme}` from the
252
253
  `<DarkLightModeThemeProvider />` in \_app.tsx to disable darkmode or lightmode
253
254
  site wide.
254
255
 
package/getting-started/improving-core-web-vitals.md CHANGED
@@ -4,9 +4,9 @@ GraphCommerce has a strict focus on getting great scores on Google's Core Web
4
4
  Vitals. This document outlines the steps we take to ensure that our frontend is
5
5
  performant.
6
6
 
7
- - LCP: Good: <=2.5s Needs Improvement: <=4s Bad: >4s
8
- - CLS: Good: <=0.1 Needs improvement: <=0.25 Bad: >0.25
9
- - INP: Good: <=200ms Needs improvement: <=500ms Bad: >500ms
7
+ - LCP: Good: \<=2.5s Needs Improvement: \<=4s Bad: \>4s
8
+ - CLS: Good: \<=0.1 Needs improvement: \<=0.25 Bad: \>0.25
9
+ - INP: Good: \<=200ms Needs improvement: \<=500ms Bad: \>500ms
10
10
 
11
11
  To get a good LCP and CLS there are a few things we need to do.
12
12
 
package/package.json CHANGED
@@ -2,10 +2,10 @@
2
2
  "name": "@graphcommerce/docs",
3
3
  "homepage": "https://www.graphcommerce.org/docs",
4
4
  "repository": "github:graphcommerce-org/graphcommerce/docs",
5
- "version": "9.0.1-canary.0",
5
+ "version": "9.0.1",
6
6
  "sideEffects": true,
7
7
  "peerDependencies": {
8
- "@graphcommerce/prettier-config-pwa": "^9.0.1-canary.0"
8
+ "@graphcommerce/prettier-config-pwa": "^9.0.1"
9
9
  },
10
10
  "prettier": "@graphcommerce/prettier-config-pwa"
11
11
  }