Skip to content

Commit b8044fd

Browse files
authored
fix minor typos (#531)
1 parent 35c77ab commit b8044fd

File tree

2 files changed

+14
-12
lines changed

2 files changed

+14
-12
lines changed

packages/pwa/README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ By default, the Retail App is configured to a single locale, single site project
8888
The `sites.js` file contains definition of the sites that you have configured in Business Manager. The following example shows configuration for `RefArch` and `RefArchGlobal` sites:
8989

9090
```js
91-
\\ /config/sites.js
91+
// /config/sites.js
9292

9393
module.exports = [
9494
{
@@ -138,15 +138,17 @@ module.exports = [
138138

139139
Optionally, You can then map the site IDs with aliases in `/config/default.js` file and also set default site. If no alias is defined for the site, then IDs are used in URLs.
140140

141-
```
142-
\\ /config/default.js
143-
144-
defaultSite: 'RefArchGlobal',
145-
siteAliases: {
146-
RefArch: 'us',
147-
RefArchGlobal: 'global',
148-
NTOManaged: 'nto'
149-
},
141+
```js
142+
// /config/default.js
143+
module.exports = {
144+
defaultSite: 'RefArchGlobal',
145+
siteAliases: {
146+
RefArch: 'us',
147+
RefArchGlobal: 'global',
148+
NTOManaged: 'nto'
149+
},
150+
// the rest of the config
151+
}
150152
```
151153

152154
If you set `url.showDefault` to `true` in `/config/default.js` file, then default locale and site are set in the URL of your Retail app. In addition to site alias, you can also configure aliases for your locale in `sites.js` file. If you configured alias, URL will reflect that instead of your locale ID.
@@ -164,4 +166,4 @@ The full documentation for PWA Kit is hosted on the [Salesforce Developers](http
164166
- [Configuration Options](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/configuration-options.html)
165167
- [Pushing and Deploying Bundles](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/pushing-and-deploying-bundles.html)
166168
- [The Retail React App](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/retail-react-app.html)
167-
- [Proxying Requests](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/proxying-requests.html)
169+
- [Proxying Requests](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/proxying-requests.html)

packages/pwa/app/utils/url.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ export const removeQueryParamsFromPath = (path, keys) => {
240240
* url {
241241
* locale: "query_param",
242242
* site: "path",
243-
* showDefault: true
243+
* showDefaults: true
244244
* }
245245
*
246246
*

0 commit comments

Comments
 (0)