@graphcommerce/docs 9.0.0 → 9.0.1-canary.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 (6) hide show
  1. package/CHANGELOG.md +16 -91
  2. package/contributing.md +2 -2
  3. package/framework/seo.md +1 -1
  4. package/framework/theming.md +5 -4
  5. package/getting-started/improving-core-web-vitals.md +3 -3
  6. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -1,119 +1,44 @@
1
1
  # Change Log
2
2
 
3
- ## 9.0.0
4
-
5
- ### Minor Changes
6
-
7
- - [#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))
8
-
9
- - [#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`.
10
-
11
- - `COMPACT` means: `< Page X of Y >`
12
- - `EXTENDED` means: `< 1 2 ... [5] ... 10 11 >` ([@FrankHarland](https://github.com/FrankHarland))
3
+ ## 9.0.1-canary.1
13
4
 
14
5
  ### Patch Changes
15
6
 
16
- - [#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))
17
-
18
- - [#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))
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))
19
8
 
20
- - [#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))
21
-
22
- - [#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))
23
-
24
- - [#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))
25
-
26
- - [#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))
27
-
28
- - [#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))
29
-
30
- - [#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))
31
-
32
- ## 9.0.0-canary.118
33
-
34
- ## 9.0.0-canary.117
35
-
36
- ## 9.0.0-canary.116
37
-
38
- ## 9.0.0-canary.115
39
-
40
- ## 9.0.0-canary.114
9
+ ## 9.0.1-canary.0
41
10
 
42
11
  ### Patch Changes
43
12
 
44
- - [#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))
45
-
46
- ## 9.0.0-canary.113
47
-
48
- ## 9.0.0-canary.112
49
-
50
- ## 9.0.0-canary.111
51
-
52
- ## 9.0.0-canary.110
13
+ - [#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))
53
14
 
54
- ## 9.0.0-canary.109
15
+ ## 9.0.0
55
16
 
56
- ## 9.0.0-canary.108
17
+ ### Major Changes
57
18
 
58
- ### Patch Changes
19
+ - [#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))
59
20
 
60
- - [#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))
21
+ - [#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))
61
22
 
62
- ## 9.0.0-canary.107
23
+ - [#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))
63
24
 
64
- ## 9.0.0-canary.106
25
+ ### Minor Changes
65
26
 
66
- ## 9.0.0-canary.105
27
+ - [#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))
67
28
 
68
29
  ### Patch Changes
69
30
 
70
- - [#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))
71
-
72
- ## 9.0.0-canary.104
73
-
74
- ## 9.0.0-canary.103
31
+ - [#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))
75
32
 
76
- ## 9.0.0-canary.62
33
+ - [#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))
77
34
 
78
- ### Patch Changes
35
+ - [#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))
79
36
 
80
37
  - [#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))
81
38
 
82
- ## 9.0.0-canary.56
83
-
84
- ### Patch Changes
85
-
86
- - [#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))
87
-
88
- ## 8.1.0-canary.41
89
-
90
- ### Patch Changes
91
-
92
- - [#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))
93
-
94
- ## 8.1.0-canary.9
95
-
96
- ### Patch Changes
97
-
98
- - [#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))
99
-
100
- ## 8.1.0-canary.8
101
-
102
- ### Patch Changes
103
-
104
- - [#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))
105
-
106
- ## 8.1.0-canary.6
107
-
108
- ### Patch Changes
109
-
110
- - [#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))
111
-
112
- ## 8.0.6-canary.0
113
-
114
- ### Patch Changes
39
+ - [#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))
115
40
 
116
- - [#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))
41
+ - [#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))
117
42
 
118
43
  ## 8.0.2
119
44
 
package/contributing.md CHANGED
@@ -57,7 +57,7 @@ File structure of GraphCommerce
57
57
  ### Formatting and Linting
58
58
 
59
59
  GraphCommerce uses ESLint for linting and Prettier for code formatting. Install
60
- the [recommended VS Code extensions](../docs/getting-started/vscode.md)
60
+ the [recommended VS Code extensions](../docs/framework/vscode.md)
61
61
 
62
62
  <!--
63
63
  ### Contributor License Agreement
@@ -106,7 +106,7 @@ need to sign the CLA once.
106
106
  because every change made here must be applied by every developer upgrading a
107
107
  GraphCommerce project
108
108
  - Extract code changes made and move them into packages where possible.
109
- - Stylistic only changes usually aren't prefered, less changes often is
109
+ - Stylistic only changes usually aren't preferred, less changes often is
110
110
  better.
111
111
 
112
112
  ## Next steps
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.0",
5
+ "version": "9.0.1-canary.1",
6
6
  "sideEffects": true,
7
7
  "peerDependencies": {
8
- "@graphcommerce/prettier-config-pwa": "^9.0.0"
8
+ "@graphcommerce/prettier-config-pwa": "^9.0.1-canary.1"
9
9
  },
10
10
  "prettier": "@graphcommerce/prettier-config-pwa"
11
11
  }