@graphcommerce/docs 4.2.0 → 4.4.0

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 (19) hide show
  1. package/CHANGELOG.md +49 -96
  2. package/contributing.md +90 -0
  3. package/framework/deployment.md +1 -1
  4. package/framework/environment-variables.md +1 -1
  5. package/framework/graphcms.md +1 -1
  6. package/framework/icons.md +1 -1
  7. package/framework/readme.md +1 -1
  8. package/framework/static-generation.md +1 -1
  9. package/framework/theming.md +2 -2
  10. package/framework/troubleshooting.md +1 -1
  11. package/getting-started/create.md +1 -1
  12. package/getting-started/graphcms-component.md +1 -1
  13. package/getting-started/header.md +1 -1
  14. package/getting-started/pages.md +1 -1
  15. package/getting-started/readme.md +1 -1
  16. package/getting-started/start-building.md +1 -1
  17. package/package.json +1 -1
  18. package/readme.md +2 -2
  19. package/roadmap.md +2 -2
package/CHANGELOG.md CHANGED
@@ -1,135 +1,109 @@
1
1
  # Change Log
2
2
 
3
+ ## 4.4.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [#1320](https://github.com/graphcommerce-org/graphcommerce/pull/1320) [`2ecac6e06`](https://github.com/graphcommerce-org/graphcommerce/commit/2ecac6e06ad19257acfd18e9042c5f81f66b476e) Thanks [@ErwinOtten](https://github.com/ErwinOtten)! - Sort order, add link to create feature request
8
+
9
+ ## 4.3.0
10
+
11
+ ### Minor Changes
12
+
13
+ - [#1311](https://github.com/graphcommerce-org/graphcommerce/pull/1311) [`af7c45d65`](https://github.com/graphcommerce-org/graphcommerce/commit/af7c45d650c4e1472933ab5393bb370195f3e708) Thanks [@ErwinOtten](https://github.com/ErwinOtten)! - Add contributing
14
+
15
+ ## 4.2.1
16
+
17
+ ### Patch Changes
18
+
19
+ - [#1316](https://github.com/graphcommerce-org/graphcommerce/pull/1316) [`6a8c84fb9`](https://github.com/graphcommerce-org/graphcommerce/commit/6a8c84fb910b9e23cdb08825b87c238510484f4a) Thanks [@paales](https://github.com/paales)! - Renamed all repository references to the [new repository](https://github.com/graphcommerce-org/graphcommerce).
20
+
3
21
  ## 4.2.0
4
22
 
5
23
  ### Minor Changes
6
24
 
7
- - [`2eaf3f7c7`](https://github.com/ho-nl/m2-pwa/commit/2eaf3f7c77b20da78a167b9fdb641cdd26a17e21)
8
- Thanks [@ErwinOtten](https://github.com/ErwinOtten)! - Upload images to github
25
+ - [`2eaf3f7c7`](https://github.com/ho-nl/m2-pwa/commit/2eaf3f7c77b20da78a167b9fdb641cdd26a17e21) Thanks [@ErwinOtten](https://github.com/ErwinOtten)! - Upload images to github
9
26
 
10
27
  ## 4.1.0
11
28
 
12
29
  ### Minor Changes
13
30
 
14
- - [`ef499815c`](https://github.com/ho-nl/m2-pwa/commit/ef499815cb1d1e040408ae697f8f3156b5478020)
15
- Thanks [@ErwinOtten](https://github.com/ErwinOtten)! - Fix build breaking spacing
31
+ - [`ef499815c`](https://github.com/ho-nl/m2-pwa/commit/ef499815cb1d1e040408ae697f8f3156b5478020) Thanks [@ErwinOtten](https://github.com/ErwinOtten)! - Fix build breaking spacing
16
32
 
17
33
  ### Patch Changes
18
34
 
19
- - [`12fc8166f`](https://github.com/ho-nl/m2-pwa/commit/12fc8166fd255db87862a08504a5a88552e41e08)
20
- Thanks [@ErwinOtten](https://github.com/ErwinOtten)! - Fix build breaking spaces
35
+ - [`12fc8166f`](https://github.com/ho-nl/m2-pwa/commit/12fc8166fd255db87862a08504a5a88552e41e08) Thanks [@ErwinOtten](https://github.com/ErwinOtten)! - Fix build breaking spaces
21
36
 
22
37
  ## 4.0.1
23
38
 
24
39
  ### Patch Changes
25
40
 
26
- - [`2db82d114`](https://github.com/ho-nl/m2-pwa/commit/2db82d114ffd4b4860e5a31ce0f2cd170732bda6)
27
- Thanks [@paales](https://github.com/paales)! - Docs improvements: add alt attribute to docs
28
- images, markup external links, images as markdown, play video inline
41
+ - [`2db82d114`](https://github.com/ho-nl/m2-pwa/commit/2db82d114ffd4b4860e5a31ce0f2cd170732bda6) Thanks [@paales](https://github.com/paales)! - Docs improvements: add alt attribute to docs images, markup external links, images as markdown, play video inline
29
42
 
30
43
  ## 4.0.0
31
44
 
32
45
  ### Major Changes
33
46
 
34
- - [#1302](https://github.com/ho-nl/m2-pwa/pull/1302)
35
- [`22ea2a0af`](https://github.com/ho-nl/m2-pwa/commit/22ea2a0af373dbd427e85f6ac82a074b1928a289)
36
- Thanks [@paales](https://github.com/paales)! - Moved all rendering of docs to
37
- https://www.graphcommerce.org/docs and use this only as a content package.
47
+ - [#1302](https://github.com/ho-nl/m2-pwa/pull/1302) [`22ea2a0af`](https://github.com/ho-nl/m2-pwa/commit/22ea2a0af373dbd427e85f6ac82a074b1928a289) Thanks [@paales](https://github.com/paales)! - Moved all rendering of docs to https://www.graphcommerce.org/docs and use this only as a content package.
38
48
 
39
49
  ## 3.1.4
40
50
 
41
51
  ### Patch Changes
42
52
 
43
- - [`29c967b09`](https://github.com/ho-nl/m2-pwa/commit/29c967b096ebc2e02049c0edc8614cc432c66187)
44
- Thanks [@paales](https://github.com/paales)! - publish docs privately on npm so it can be used for
45
- the docs website
53
+ - [`29c967b09`](https://github.com/ho-nl/m2-pwa/commit/29c967b096ebc2e02049c0edc8614cc432c66187) Thanks [@paales](https://github.com/paales)! - publish docs privately on npm so it can be used for the docs website
46
54
 
47
55
  ## 3.1.3
48
56
 
49
57
  ### Patch Changes
50
58
 
51
- - [#1296](https://github.com/ho-nl/m2-pwa/pull/1296)
52
- [`8473123fa`](https://github.com/ho-nl/m2-pwa/commit/8473123fa7d3f3eb1d282d9b4205c803a88010ea)
53
- Thanks [@paales](https://github.com/paales)! - implement handling for canonical URLs based on
54
- NEXT_PUBLIC_SITE_URL
59
+ - [#1296](https://github.com/ho-nl/m2-pwa/pull/1296) [`8473123fa`](https://github.com/ho-nl/m2-pwa/commit/8473123fa7d3f3eb1d282d9b4205c803a88010ea) Thanks [@paales](https://github.com/paales)! - implement handling for canonical URLs based on NEXT_PUBLIC_SITE_URL
55
60
 
56
- - Updated dependencies
57
- [[`a9cff2ce6`](https://github.com/ho-nl/m2-pwa/commit/a9cff2ce63fce5b86e9fd6bf63c10c782326d50e),
58
- [`8473123fa`](https://github.com/ho-nl/m2-pwa/commit/8473123fa7d3f3eb1d282d9b4205c803a88010ea),
59
- [`50e205c51`](https://github.com/ho-nl/m2-pwa/commit/50e205c51f4d0d67d41d22fd70e8ed9a0996489e)]:
61
+ - Updated dependencies [[`a9cff2ce6`](https://github.com/ho-nl/m2-pwa/commit/a9cff2ce63fce5b86e9fd6bf63c10c782326d50e), [`8473123fa`](https://github.com/ho-nl/m2-pwa/commit/8473123fa7d3f3eb1d282d9b4205c803a88010ea), [`50e205c51`](https://github.com/ho-nl/m2-pwa/commit/50e205c51f4d0d67d41d22fd70e8ed9a0996489e)]:
60
62
  - @graphcommerce/next-ui@4.2.2
61
63
 
62
64
  ## 3.1.2
63
65
 
64
66
  ### Patch Changes
65
67
 
66
- - [#1292](https://github.com/ho-nl/m2-pwa/pull/1292)
67
- [`5a1ba9e66`](https://github.com/ho-nl/m2-pwa/commit/5a1ba9e664abbac89c4f5f71f7d6d6ed1aefa5c0)
68
- Thanks [@paales](https://github.com/paales)! - Renamed SvgIcon to IconSvg to prevent collisions
69
- with MUI
68
+ - [#1292](https://github.com/ho-nl/m2-pwa/pull/1292) [`5a1ba9e66`](https://github.com/ho-nl/m2-pwa/commit/5a1ba9e664abbac89c4f5f71f7d6d6ed1aefa5c0) Thanks [@paales](https://github.com/paales)! - Renamed SvgIcon to IconSvg to prevent collisions with MUI
70
69
 
71
- * [#1292](https://github.com/ho-nl/m2-pwa/pull/1292)
72
- [`63f9b56eb`](https://github.com/ho-nl/m2-pwa/commit/63f9b56eb68ba790567ff1427e599fd2c3c8f1ee)
73
- Thanks [@paales](https://github.com/paales)! - added responsive size to the Fab component
70
+ * [#1292](https://github.com/ho-nl/m2-pwa/pull/1292) [`63f9b56eb`](https://github.com/ho-nl/m2-pwa/commit/63f9b56eb68ba790567ff1427e599fd2c3c8f1ee) Thanks [@paales](https://github.com/paales)! - added responsive size to the Fab component
74
71
 
75
- * Updated dependencies
76
- [[`5a1ba9e66`](https://github.com/ho-nl/m2-pwa/commit/5a1ba9e664abbac89c4f5f71f7d6d6ed1aefa5c0),
77
- [`990df655b`](https://github.com/ho-nl/m2-pwa/commit/990df655b73b469718d6cb5837ee65dfe2ad6a1d),
78
- [`63f9b56eb`](https://github.com/ho-nl/m2-pwa/commit/63f9b56eb68ba790567ff1427e599fd2c3c8f1ee)]:
72
+ * Updated dependencies [[`5a1ba9e66`](https://github.com/ho-nl/m2-pwa/commit/5a1ba9e664abbac89c4f5f71f7d6d6ed1aefa5c0), [`990df655b`](https://github.com/ho-nl/m2-pwa/commit/990df655b73b469718d6cb5837ee65dfe2ad6a1d), [`63f9b56eb`](https://github.com/ho-nl/m2-pwa/commit/63f9b56eb68ba790567ff1427e599fd2c3c8f1ee)]:
79
73
  - @graphcommerce/next-ui@4.2.0
80
74
 
81
75
  ## 3.1.1
82
76
 
83
77
  ### Patch Changes
84
78
 
85
- - [#1285](https://github.com/ho-nl/m2-pwa/pull/1285)
86
- [`c85294ba6`](https://github.com/ho-nl/m2-pwa/commit/c85294ba6d742ce78c074559a1e95409b25a5017)
87
- Thanks [@paales](https://github.com/paales)! - upgraded dependencies
79
+ - [#1285](https://github.com/ho-nl/m2-pwa/pull/1285) [`c85294ba6`](https://github.com/ho-nl/m2-pwa/commit/c85294ba6d742ce78c074559a1e95409b25a5017) Thanks [@paales](https://github.com/paales)! - upgraded dependencies
88
80
 
89
- - Updated dependencies
90
- [[`c85294ba6`](https://github.com/ho-nl/m2-pwa/commit/c85294ba6d742ce78c074559a1e95409b25a5017)]:
81
+ - Updated dependencies [[`c85294ba6`](https://github.com/ho-nl/m2-pwa/commit/c85294ba6d742ce78c074559a1e95409b25a5017)]:
91
82
  - @graphcommerce/next-ui@4.1.3
92
83
 
93
84
  ## 3.1.0
94
85
 
95
86
  ### Minor Changes
96
87
 
97
- - [#1281](https://github.com/ho-nl/m2-pwa/pull/1281)
98
- [`756ac889a`](https://github.com/ho-nl/m2-pwa/commit/756ac889a711b0c46a9e6948555f87c8fcaf4c5f)
99
- Thanks [@paales](https://github.com/paales)! - New mobile menu using a separate route, allows us
100
- to use the LayoutOverlay which gives all sorts of nice customization options.
88
+ - [#1281](https://github.com/ho-nl/m2-pwa/pull/1281) [`756ac889a`](https://github.com/ho-nl/m2-pwa/commit/756ac889a711b0c46a9e6948555f87c8fcaf4c5f) Thanks [@paales](https://github.com/paales)! - New mobile menu using a separate route, allows us to use the LayoutOverlay which gives all sorts of nice customization options.
101
89
 
102
- * [#1278](https://github.com/ho-nl/m2-pwa/pull/1278)
103
- [`81ea406d5`](https://github.com/ho-nl/m2-pwa/commit/81ea406d54d6b5c662c030a7fea444abc4117a20)
104
- Thanks [@ErwinOtten](https://github.com/ErwinOtten)! - Written documentation for GraphCommerce!
105
- 👩‍🏫🧑‍🏫📚📖
90
+ * [#1278](https://github.com/ho-nl/m2-pwa/pull/1278) [`81ea406d5`](https://github.com/ho-nl/m2-pwa/commit/81ea406d54d6b5c662c030a7fea444abc4117a20) Thanks [@ErwinOtten](https://github.com/ErwinOtten)! - Written documentation for GraphCommerce! 👩‍🏫🧑‍🏫📚📖
106
91
 
107
- - [#1284](https://github.com/ho-nl/m2-pwa/pull/1284)
108
- [`5ffcb56bf`](https://github.com/ho-nl/m2-pwa/commit/5ffcb56bfcbe49ebeaf24f9341e819a145ab9a14)
109
- Thanks [@paales](https://github.com/paales)! - SvgIcon is now more extenable and flexible:
92
+ - [#1284](https://github.com/ho-nl/m2-pwa/pull/1284) [`5ffcb56bf`](https://github.com/ho-nl/m2-pwa/commit/5ffcb56bfcbe49ebeaf24f9341e819a145ab9a14) Thanks [@paales](https://github.com/paales)! - SvgIcon is now more extenable and flexible:
110
93
 
111
- - It will automatically calculate the stroke-width of the SVG based on the rendered size, allowing
112
- for a more flexible use for icons.
94
+ - It will automatically calculate the stroke-width of the SVG based on the rendered size, allowing for a more flexible use for icons.
113
95
 
114
96
  - Make SvgIcon themable in your own Theme.
115
97
 
116
98
  - Create overrides for components that will be used throughout the app.
117
99
 
118
- * [#1283](https://github.com/ho-nl/m2-pwa/pull/1283)
119
- [`cc7f9e9ed`](https://github.com/ho-nl/m2-pwa/commit/cc7f9e9eddd90f619a5041890b4e714a2314db2b)
120
- Thanks [@paales](https://github.com/paales)! - Added a new search function to the docs
100
+ * [#1283](https://github.com/ho-nl/m2-pwa/pull/1283) [`cc7f9e9ed`](https://github.com/ho-nl/m2-pwa/commit/cc7f9e9eddd90f619a5041890b4e714a2314db2b) Thanks [@paales](https://github.com/paales)! - Added a new search function to the docs
121
101
 
122
102
  ### Patch Changes
123
103
 
124
- - [`973ff8645`](https://github.com/ho-nl/m2-pwa/commit/973ff86452a70ade9f4db13fdda6e963d7220e96)
125
- Thanks [@paales](https://github.com/paales)! - made packages public
104
+ - [`973ff8645`](https://github.com/ho-nl/m2-pwa/commit/973ff86452a70ade9f4db13fdda6e963d7220e96) Thanks [@paales](https://github.com/paales)! - made packages public
126
105
 
127
- - Updated dependencies
128
- [[`4bb963d75`](https://github.com/ho-nl/m2-pwa/commit/4bb963d7595b5ce6e3a4924cc2e3e8b0210cdcd6),
129
- [`973ff8645`](https://github.com/ho-nl/m2-pwa/commit/973ff86452a70ade9f4db13fdda6e963d7220e96),
130
- [`81ea406d5`](https://github.com/ho-nl/m2-pwa/commit/81ea406d54d6b5c662c030a7fea444abc4117a20),
131
- [`3a719c88c`](https://github.com/ho-nl/m2-pwa/commit/3a719c88cad1eab58602de28c41adc0fc4827e1d),
132
- [`5ffcb56bf`](https://github.com/ho-nl/m2-pwa/commit/5ffcb56bfcbe49ebeaf24f9341e819a145ab9a14)]:
106
+ - Updated dependencies [[`4bb963d75`](https://github.com/ho-nl/m2-pwa/commit/4bb963d7595b5ce6e3a4924cc2e3e8b0210cdcd6), [`973ff8645`](https://github.com/ho-nl/m2-pwa/commit/973ff86452a70ade9f4db13fdda6e963d7220e96), [`81ea406d5`](https://github.com/ho-nl/m2-pwa/commit/81ea406d54d6b5c662c030a7fea444abc4117a20), [`3a719c88c`](https://github.com/ho-nl/m2-pwa/commit/3a719c88cad1eab58602de28c41adc0fc4827e1d), [`5ffcb56bf`](https://github.com/ho-nl/m2-pwa/commit/5ffcb56bfcbe49ebeaf24f9341e819a145ab9a14)]:
133
107
  - @graphcommerce/framer-next-pages@3.1.0
134
108
  - @graphcommerce/image@3.1.0
135
109
  - @graphcommerce/next-ui@4.1.2
@@ -140,28 +114,13 @@
140
114
 
141
115
  ### Patch Changes
142
116
 
143
- - [#1276](https://github.com/ho-nl/m2-pwa/pull/1276)
144
- [`ce09388e0`](https://github.com/ho-nl/m2-pwa/commit/ce09388e0d7ef33aee660612340f6fbae15ceec2)
145
- Thanks [@paales](https://github.com/paales)! - We've moved lots of internal packages from
146
- `dependencies` to `peerDependencies`. The result of this is that there will be significantly less
147
- duplicate packages in the node_modules folders.
148
-
149
- * [#1276](https://github.com/ho-nl/m2-pwa/pull/1276)
150
- [`52a45bba4`](https://github.com/ho-nl/m2-pwa/commit/52a45bba4dc6dd6df3c81f5023df7d23ed8a534d)
151
- Thanks [@paales](https://github.com/paales)! - Upgraded to
152
- [NextJS 12.1](https://nextjs.org/blog/next-12-1)! This is just for compatibility, but we'll be
153
- implementing
154
- [On-demand Incremental Static Regeneration](https://nextjs.org/blog/next-12-1#on-demand-incremental-static-regeneration-beta)
155
- soon.
156
-
157
- This will greatly reduce the requirement to rebuid stuff and we'll add a management UI on the
158
- frontend to be able to revalidate pages manually.
159
-
160
- * Updated dependencies
161
- [[`381e4c86a`](https://github.com/ho-nl/m2-pwa/commit/381e4c86a8321ce96e1fa5c7d3c0a0c0ff3e02c7),
162
- [`ce09388e0`](https://github.com/ho-nl/m2-pwa/commit/ce09388e0d7ef33aee660612340f6fbae15ceec2),
163
- [`e7c8e2756`](https://github.com/ho-nl/m2-pwa/commit/e7c8e2756d637cbcd2e793d62ef5721d35d9fa7b),
164
- [`52a45bba4`](https://github.com/ho-nl/m2-pwa/commit/52a45bba4dc6dd6df3c81f5023df7d23ed8a534d)]:
117
+ - [#1276](https://github.com/ho-nl/m2-pwa/pull/1276) [`ce09388e0`](https://github.com/ho-nl/m2-pwa/commit/ce09388e0d7ef33aee660612340f6fbae15ceec2) Thanks [@paales](https://github.com/paales)! - We've moved lots of internal packages from `dependencies` to `peerDependencies`. The result of this is that there will be significantly less duplicate packages in the node_modules folders.
118
+
119
+ * [#1276](https://github.com/ho-nl/m2-pwa/pull/1276) [`52a45bba4`](https://github.com/ho-nl/m2-pwa/commit/52a45bba4dc6dd6df3c81f5023df7d23ed8a534d) Thanks [@paales](https://github.com/paales)! - Upgraded to [NextJS 12.1](https://nextjs.org/blog/next-12-1)! This is just for compatibility, but we'll be implementing [On-demand Incremental Static Regeneration](https://nextjs.org/blog/next-12-1#on-demand-incremental-static-regeneration-beta) soon.
120
+
121
+ This will greatly reduce the requirement to rebuid stuff and we'll add a management UI on the frontend to be able to revalidate pages manually.
122
+
123
+ * Updated dependencies [[`381e4c86a`](https://github.com/ho-nl/m2-pwa/commit/381e4c86a8321ce96e1fa5c7d3c0a0c0ff3e02c7), [`ce09388e0`](https://github.com/ho-nl/m2-pwa/commit/ce09388e0d7ef33aee660612340f6fbae15ceec2), [`e7c8e2756`](https://github.com/ho-nl/m2-pwa/commit/e7c8e2756d637cbcd2e793d62ef5721d35d9fa7b), [`52a45bba4`](https://github.com/ho-nl/m2-pwa/commit/52a45bba4dc6dd6df3c81f5023df7d23ed8a534d)]:
165
124
  - @graphcommerce/framer-next-pages@3.0.2
166
125
  - @graphcommerce/next-ui@4.1.1
167
126
  - @graphcommerce/next-config@3.0.2
@@ -170,11 +129,8 @@
170
129
 
171
130
  ### Patch Changes
172
131
 
173
- - [`0cbaa878b`](https://github.com/ho-nl/m2-pwa/commit/0cbaa878b8a844d5abbeb1797b625a33130e6514)
174
- Thanks [@paales](https://github.com/paales)! - Added homepage and repository package.json files,
175
- so that the packages link to back to the website and repository
176
- - Updated dependencies
177
- [[`0cbaa878b`](https://github.com/ho-nl/m2-pwa/commit/0cbaa878b8a844d5abbeb1797b625a33130e6514)]:
132
+ - [`0cbaa878b`](https://github.com/ho-nl/m2-pwa/commit/0cbaa878b8a844d5abbeb1797b625a33130e6514) Thanks [@paales](https://github.com/paales)! - Added homepage and repository package.json files, so that the packages link to back to the website and repository
133
+ - Updated dependencies [[`0cbaa878b`](https://github.com/ho-nl/m2-pwa/commit/0cbaa878b8a844d5abbeb1797b625a33130e6514)]:
178
134
  - @graphcommerce/framer-next-pages@3.0.1
179
135
  - @graphcommerce/next-ui@4.0.1
180
136
  - @graphcommerce/next-config@3.0.1
@@ -183,14 +139,11 @@
183
139
 
184
140
  ### Major Changes
185
141
 
186
- - [#1258](https://github.com/ho-nl/m2-pwa/pull/1258)
187
- [`ad36382a4`](https://github.com/ho-nl/m2-pwa/commit/ad36382a4d55d83d9e47b7eb6a02671a2a631a05)
188
- Thanks [@paales](https://github.com/paales)! - Upgraded to Material UI 5
142
+ - [#1258](https://github.com/ho-nl/m2-pwa/pull/1258) [`ad36382a4`](https://github.com/ho-nl/m2-pwa/commit/ad36382a4d55d83d9e47b7eb6a02671a2a631a05) Thanks [@paales](https://github.com/paales)! - Upgraded to Material UI 5
189
143
 
190
144
  ### Patch Changes
191
145
 
192
- - Updated dependencies
193
- [[`ad36382a4`](https://github.com/ho-nl/m2-pwa/commit/ad36382a4d55d83d9e47b7eb6a02671a2a631a05)]:
146
+ - Updated dependencies [[`ad36382a4`](https://github.com/ho-nl/m2-pwa/commit/ad36382a4d55d83d9e47b7eb6a02671a2a631a05)]:
194
147
  - @graphcommerce/framer-next-pages@3.0.0
195
148
  - @graphcommerce/next-ui@4.0.0
196
149
  - @graphcommerce/next-config@3.0.0
package/contributing.md ADDED
@@ -0,0 +1,90 @@
1
+ # Contributing to GraphCommerce
2
+
3
+ Looking to contribute something to GraphCommerce? Here's how you can help.
4
+
5
+ Please take a moment to review this document in order to make the contribution
6
+ process easy and effective for everyone involved.
7
+
8
+ ### Bug reports
9
+
10
+ Well-written, thorough bug reports are a great way to contribute to the project.
11
+ Before raising a new issue, please check our
12
+ [issues list ↗](https://github.com/graphcommerce-org/graphcommerce/issues) to
13
+ determine whether the issue you encountered has already been reported.
14
+
15
+ A good bug report should be self-explanatory. Use the
16
+ [bug report template ↗](https://github.com/graphcommerce-org/graphcommerce/issues/new/choose)
17
+ to create a bug report.
18
+
19
+ ### Feature requests
20
+
21
+ Feature requests are welcome. Please take a moment to find out whether your idea
22
+ fits with the scope and aims of the project. It's up to you to make a strong
23
+ case to convince us of the merits of this feature.
24
+
25
+ Provide as much detail and context as possible. Use the
26
+ [feature request template ↗](https://github.com/graphcommerce-org/graphcommerce/issues/new/choose)
27
+ to create a feature request.
28
+
29
+ ## Pull requests
30
+
31
+ Good pull requests (e.g. patches, improvements, new features) are a fantastic
32
+ help. Please
33
+ [ask first ↗](https://join.slack.com/t/graphcommerce/shared_invite/zt-11rmgq1ad-F~0daNtKcSvtcC4eQRzjeQ)
34
+ before embarking on any significant pull request (e.g. implementing features or
35
+ refactoring code), otherwise you risk spending a lot of time working on
36
+ something that might not be relevant to the project.
37
+
38
+ ### File structure
39
+
40
+ ```txt
41
+ File structure of GraphCommerce
42
+
43
+ ├── docs
44
+ ├── examples
45
+ └── magento-graphcms
46
+ ├── packages
47
+ ```
48
+
49
+ - To make changes to the magento-graphcms template, edit the files in
50
+ examples/magento-graphcms.
51
+
52
+ - To modify GraphCommerce framework, components, edit the files in
53
+ packages/graphcommerce.
54
+
55
+ - To make changes to the docs, edit the files in docs
56
+
57
+ ### Formatting and Linting
58
+
59
+ GraphCommerce uses ESLint for linting and Prettier for code formatting. Install
60
+ the [recommended VS Code extensions](../docs/getting-started/vscode.md)
61
+
62
+ ### Contributor License Agreement
63
+
64
+ Please make sure you have signed our Contributor License Agreement. We are not
65
+ asking you to assign copyright to us, but to give us the right to distribute
66
+ your code without restriction. We ask this of all contributors in order to
67
+ assure our users of the origin and continuing existence of the code. You only
68
+ need to sign the CLA once.
69
+
70
+ ### Creating a pull request
71
+
72
+ 1. Create a pull request. The PR can stay open until you are ready to merge.
73
+ 2. Add your changes
74
+ 3. Add a changeset
75
+
76
+ - Run 'yarn changeset' and select minor bump. Commit the changeset that is
77
+ created.
78
+
79
+ <figure>
80
+
81
+ ![yarn changeset](https://user-images.githubusercontent.com/1251986/157868337-0fa27e88-cf35-4e38-a59c-72c72ef6b054.jpg)
82
+
83
+ <figcaption>Select minor bump when running `yarn changeset`</figcaption>
84
+ </figure>
85
+
86
+ ## Next steps
87
+
88
+ - Discuss your ideas in the public
89
+ [ Slack community. ↗](https://join.slack.com/t/graphcommerce/shared_invite/zt-11rmgq1ad-F~0daNtKcSvtcC4eQRzjeQ)
90
+ chat
package/framework/deployment.md CHANGED
@@ -1,7 +1,7 @@
1
1
  > **Developer preview**
2
2
  > This is a developer preview of GraphCommerce. The documentation will be
3
3
  > updated as GraphCommerce introduces
4
- > [new features and refines existing functionality](https://github.com/ho-nl/m2-pwa/releases).
4
+ > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
5
5
 
6
6
  # Deploy a Graphcommerce app with Vercel
7
7
 
package/framework/environment-variables.md CHANGED
@@ -1,7 +1,7 @@
1
1
  > **Developer preview**
2
2
  > This is a developer preview of GraphCommerce. The documentation will be
3
3
  > updated as GraphCommerce introduces
4
- > [new features and refines existing functionality](https://github.com/ho-nl/m2-pwa/releases).
4
+ > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
5
5
 
6
6
  # Environment Variables
7
7
 
package/framework/graphcms.md CHANGED
@@ -5,7 +5,7 @@ menu: GraphCMS
5
5
  > **Developer preview**
6
6
  > This is a developer preview of GraphCommerce. The documentation will be
7
7
  > updated as GraphCommerce introduces
8
- > [new features and refines existing functionality](https://github.com/ho-nl/m2-pwa/releases).
8
+ > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
9
9
 
10
10
  # GraphCMS
11
11
 
package/framework/icons.md CHANGED
@@ -1,7 +1,7 @@
1
1
  > **Developer preview**
2
2
  > This is a developer preview of GraphCommerce. The documentation will be
3
3
  > updated as GraphCommerce introduces
4
- > [new features and refines existing functionality](https://github.com/ho-nl/m2-pwa/releases).
4
+ > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
5
5
 
6
6
  # Icons
7
7
 
package/framework/readme.md CHANGED
@@ -5,7 +5,7 @@ menu: Overview
5
5
  > **Developer preview**
6
6
  > This is a developer preview of GraphCommerce. The documentation will be
7
7
  > updated as GraphCommerce introduces
8
- > [new features and refines existing functionality](https://github.com/ho-nl/m2-pwa/releases).
8
+ > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
9
9
 
10
10
  # GraphCommerce framework overview
11
11
 
package/framework/static-generation.md CHANGED
@@ -9,7 +9,7 @@ metaDescription:
9
9
  > **Developer preview**
10
10
  > This is a developer preview of GraphCommerce. The documentation will be
11
11
  > updated as GraphCommerce introduces
12
- > [new features and refines existing functionality](https://github.com/ho-nl/m2-pwa/releases).
12
+ > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
13
13
 
14
14
  # Static Site Generation (SSG) in GraphCommerce
15
15
 
package/framework/theming.md CHANGED
@@ -66,7 +66,7 @@ Most components have props that define their look and feel. Most common are the
66
66
  IntelliSense feature, type Ctrl+Space.
67
67
  - It can be helpful to learn how a component is styled, for example, to explore
68
68
  how palette variables are used. Refer to the
69
- [MUI Button source code ↗](https://github.com/mui/material-ui/blob/master/packages/mui-material/src/Button/Button.js)
69
+ [MUI Button source code ↗](https://github.com/mui/material-ui/blob/main/packages/mui-material/src/Button/Button.js)
70
70
 
71
71
  ## Change a component's styling with the sx prop
72
72
 
@@ -255,4 +255,4 @@ should not be scaled with responsiveVal. To learn more, look into
255
255
  - Take a look at MUI's
256
256
  [Default Theme object ↗](https://mui.com/customization/default-theme/)
257
257
  - Learn more about a component's default styles by looking them up in the
258
- [MUI repository ↗](https://github.com/mui/material-ui/tree/master/packages/mui-material/src)
258
+ [MUI repository ↗](https://github.com/mui/material-ui/tree/main/packages/mui-material/src)
package/framework/troubleshooting.md CHANGED
@@ -1,7 +1,7 @@
1
1
  > **Developer preview**
2
2
  > This is a developer preview of GraphCommerce. The documentation will be
3
3
  > updated as GraphCommerce introduces
4
- > [new features and refines existing functionality](https://github.com/ho-nl/m2-pwa/releases).
4
+ > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
5
5
 
6
6
  # Troubleshouting
7
7
 
package/getting-started/create.md CHANGED
@@ -54,7 +54,7 @@ need to only install the dependencies. This is the quickest approach.
54
54
 
55
55
  ### Download the example
56
56
 
57
- 1. `git clone ... graphcommerce`
57
+ 1. `git clone git@github.com:graphcommerce-org/graphcommerce.git graphcommerce`
58
58
  2. `mkdir my-project`
59
59
  3. `cp -R graphcommerce/examples/magento-graphcms/. my-project`
60
60
  4. `rm -rf graphcommerce`
package/getting-started/graphcms-component.md CHANGED
@@ -6,7 +6,7 @@ metaTitle: Build a GraphCMS component
6
6
  > **Developer preview**
7
7
  > This is a developer preview of GraphCommerce. The documentation will be
8
8
  > updated as GraphCommerce introduces
9
- > [new features and refines existing functionality](https://github.com/ho-nl/m2-pwa/releases).
9
+ > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
10
10
 
11
11
  # Build a GraphCMS component
12
12
 
package/getting-started/header.md CHANGED
@@ -6,7 +6,7 @@ metaTitle: Build a custom header
6
6
  > **Developer preview**
7
7
  > This is a developer preview of GraphCommerce. The documentation will be
8
8
  > updated as GraphCommerce introduces
9
- > [new features and refines existing functionality](https://github.com/ho-nl/m2-pwa/releases).
9
+ > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
10
10
 
11
11
  # Build a custom header in GraphCommerce
12
12
 
package/getting-started/pages.md CHANGED
@@ -6,7 +6,7 @@ metaTitle: Build pages
6
6
  > **Developer preview**
7
7
  > This is a developer preview of GraphCommerce. The documentation will be
8
8
  > updated as GraphCommerce introduces
9
- > [new features and refines existing functionality](https://github.com/ho-nl/m2-pwa/releases).
9
+ > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
10
10
 
11
11
  # Build pages in GraphCommerce
12
12
 
package/getting-started/readme.md CHANGED
@@ -12,7 +12,7 @@ metaDescription:
12
12
  > **Developer preview**
13
13
  > This is a developer preview of GraphCommerce. The documentation will be
14
14
  > updated as GraphCommerce introduces
15
- > [new features and refines existing functionality](https://github.com/ho-nl/m2-pwa/releases).
15
+ > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
16
16
 
17
17
  # GraphCommerce magento-graphcms example overview
18
18
 
package/getting-started/start-building.md CHANGED
@@ -6,7 +6,7 @@ metaTitle: Customize a storefront
6
6
  > **Developer preview**
7
7
  > This is a developer preview of GraphCommerce. The documentation will be
8
8
  > updated as GraphCommerce introduces
9
- > [new features and refines existing functionality](https://github.com/ho-nl/m2-pwa/releases).
9
+ > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
10
10
 
11
11
  # Start building a GraphCommerce custom storefront
12
12
 
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@graphcommerce/docs",
3
3
  "homepage": "https://www.graphcommerce.org/docs",
4
4
  "repository": "github:graphcommerce-org/graphcommerce/docs",
5
- "version": "4.2.0",
5
+ "version": "4.4.0",
6
6
  "sideEffects": true,
7
7
  "devDependencies": {
8
8
  "@graphcommerce/prettier-config-pwa": "^4.0.2"
package/readme.md CHANGED
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  menu: Overview
3
- order: getting-started,framework
3
+ order: getting-started,framework, contributing, roadmap
4
4
  metaTitle: Start React, Next.js Magento PWA development here - GraphCommerce
5
5
  metaDescription:
6
6
  'GraphCommerce is the open-source PWA Studio Magento 2 alternative.
@@ -11,7 +11,7 @@ metaDescription:
11
11
  > **Developer preview**
12
12
  > This is a developer preview of GraphCommerce. The documentation will be
13
13
  > updated as GraphCommerce introduces
14
- > [new features and refines existing functionality](https://github.com/ho-nl/m2-pwa/releases).
14
+ > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
15
15
 
16
16
  # GraphCommerce
17
17
 
package/roadmap.md CHANGED
@@ -27,5 +27,5 @@ The following overview contains the status of items on the GraphCommerce roadmap
27
27
  ## Next steps
28
28
 
29
29
  - Refer to the
30
- [Changelog](https://github.com/ho-nl/m2-pwa/blob/master/CHANGELOG.md) to see
31
- what's new
30
+ [Changelog](https://github.com/graphcommerce-org/graphcommerce/releases) to
31
+ see what's new