docs: update with caveats

3nvi · Mar 28, 2020 · 8df60fa · 8df60fa
1 parent eee1eb8
commit 8df60fa
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/packages/gatsby-plugin-intl/README.md b/packages/gatsby-plugin-intl/README.md
@@ -68,8 +68,12 @@ The plugin accepts the following **optional options**:
   `URL` (which platforms like Netlify automatically populate) or to `localhost:8000` if the environment variable is not present.
 - `exludedPages`: A list page paths that the plugin should ignore. Defaults to `/404.html`.
 - `notFoundPage`: The URL for a custom 404 page. Defaults to `/404/`.
-- `deleteOriginalPages`: A boolean denoting whether to delete the original pages or retain them at
-  the original paths. Defaults to `false` for production environments and `true` for development ones.
+
+## Caveats
+
+Due to the fact that each page path is substituted with the localized one, there will be no `/` page
+in the project. Instead all `/` will be redirected to the appropriate locales. Gatsby will complain about
+the absense of an actual `/`, but it's safe to ignore it.
 
 ## License
 

diff --git a/packages/gatsby-starter-intl/README.md b/packages/gatsby-starter-intl/README.md
@@ -27,6 +27,12 @@ npm i
 npm run start
 ```
 
+## Caveats
+
+Due to the fact that each page path is substituted with the localized one, there will be no `/` page
+in the project. Instead all `/` will be redirected to the appropriate locales. Gatsby will complain about
+the absense of an actual `/`, but it's safe to ignore it.
+
 ## License
 
 MIT