Skip to content

docs(react): document the Pages Router i18n config mismatch warning #432

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
moss-bryophyta wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −1
Open

docs(react): document the Pages Router i18n config mismatch warning #432

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/en-US/react/(frameworks)/nextjs/pages-router-middleware.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ export default withGTConfig(nextConfig);

Next.js serves the default locale without a prefix and prefixes the others. For example, English uses `/about` and French uses `/fr/about`.

Importing the values keeps both configurations in sync. If you hardcode `i18n.locales` or `i18n.defaultLocale` to values that differ from `gt.config.json`, `gt-next` prints a build-time warning that Next.js internationalized routing does not match the GT config file, because Next.js can then route to a locale that GT is not configured to translate. The comparison ignores ordering, so only the set of locales matters.

Keep each page at the root of `pages`; do not add a `[locale]` segment:

<Files>
Expand Down
2 changes: 1 addition & 1 deletion docs/en-US/react/nextjs-pages-router-quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ const nextConfig: NextConfig = {
export default withGTConfig(nextConfig);
```

Next.js keeps the default locale at `/` and prefixes the other locales, such as `/es` and `/fr`. You do not need `gt-next` middleware or a `pages/[locale]` route segment. See [Pages Router locale routing](/docs/react/nextjs/pages-router-middleware) for detection and migration details.
Next.js keeps the default locale at `/` and prefixes the other locales, such as `/es` and `/fr`. You do not need `gt-next` middleware or a `pages/[locale]` route segment. Import the values from `gt.config.json` rather than repeating them, so the two configurations cannot drift; `gt-next` warns at build time when they disagree. See [Pages Router locale routing](/docs/react/nextjs/pages-router-middleware) for detection and migration details.


### 4. Add a load function for local translations
Expand Down
Loading