Skip to content

docs(i18n): fix config filename references in ADDING_TRANSLATIONS.md#5274

Open
DeekRoumy wants to merge 2 commits intoasyncapi:masterfrom
DeekRoumy:fix/i18n-config-filename-in-translations-guide
Open

docs(i18n): fix config filename references in ADDING_TRANSLATIONS.md#5274
DeekRoumy wants to merge 2 commits intoasyncapi:masterfrom
DeekRoumy:fix/i18n-config-filename-in-translations-guide

Conversation

@DeekRoumy
Copy link
Copy Markdown

@DeekRoumy DeekRoumy commented Mar 23, 2026

Summary

Fixes #5111

The ADDING_TRANSLATIONS.md guide referenced two different (incorrect) filenames for the i18n configuration file, causing confusion for contributors.

Problem

  • "Adding translations to a new page" section referenced: next-i18next-static-site.config.js
  • "Adding a new locale" section referenced: next-i18next.config.js
  • The actual file in the repository is: next-i18next.config.cjs

Changes

Updated all 4 filename references in ADDING_TRANSLATIONS.md to consistently use next-i18next.config.cjs.

Why this matters

Contributors following the guide to add translations or new locales would navigate to the wrong file, leading to confusion or setup failures.

Summary by CodeRabbit

  • Documentation
    • Updated the translation contribution guide to reference the renamed i18n configuration and updated code examples.
    • Replaced old i18n option names with the current keys (e.g., locale list and default locale).
    • Updated example locale list to include French and clarified where to add new translation namespaces.

…S.md

The guide referenced two different filenames for the i18n config:
- 'next-i18next-static-site.config.js' (in Adding translations to new page)
- 'next-i18next.config.js' (in Adding a new locale)

The actual file in the repository is 'next-i18next.config.cjs'.
Updated all references to use the correct filename.

Fixes asyncapi#5111
@netlify
Copy link
Copy Markdown

netlify bot commented Mar 23, 2026

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 9381637
🔍 Latest deploy log https://app.netlify.com/projects/asyncapi-website/deploys/69c31176a98cf00008635547
😎 Deploy Preview https://deploy-preview-5274--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Copy Markdown

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 23, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 5bc5cbc5-b0b4-497f-9169-737cb3cf6d36

📥 Commits

Reviewing files that changed from the base of the PR and between 4eca667 and 9381637.

📒 Files selected for processing (1)
  • ADDING_TRANSLATIONS.md

📝 Walkthrough

Walkthrough

Updated the translation guide to consistently reference next-i18next.config.cjs, replaced i18n option names languages/defaultLanguage with locales/defaultLocale, adjusted example locale lists (e.g., added fr), and updated code snippets and narrative to match the renamed config and keys.

Changes

Cohort / File(s) Summary
Documentation
ADDING_TRANSLATIONS.md
Standardized i18n config filename to next-i18next.config.cjs; replaced languages/defaultLanguage with locales/defaultLocale across examples and snippets; updated example locale list (added fr) and instructions for adding namespaces.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I’m a rabbit in the docs tonight,
Hopping over names to make them right. 🐇
.cjs now stands where .js once played,
Locales and defaults freshly laid,
Fluent guides so contributors smile bright.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: fixing incorrect config filename references in the ADDING_TRANSLATIONS.md documentation file.
Linked Issues check ✅ Passed The PR addresses all requirements from issue #5111: it corrects inconsistent filename references by updating all four references in ADDING_TRANSLATIONS.md to consistently use 'next-i18next.config.cjs' and aligns i18n property names with actual config.
Out of Scope Changes check ✅ Passed All changes are directly scoped to fixing the documented issue: updating ADDING_TRANSLATIONS.md filename and i18n property references. No out-of-scope modifications present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 23, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (43ec12d) to head (4eca667).

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #5274   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           22        22           
  Lines          830       830           
  Branches       159       159           
=========================================
  Hits           830       830           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@ADDING_TRANSLATIONS.md`:
- Around line 255-257: Update the docs to reference the actual config keys used
in next-i18next.config.cjs: replace instructions that say to edit `languages`
and `defaultLanguage` with the correct property names `locales` and
`defaultLocale` (and mention the file `next-i18next.config.cjs`) so contributors
are directed to modify `locales` array and `defaultLocale` value instead; apply
the same correction to the repeated section later in the doc (lines ~281-299).

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 2386b056-ecea-4d57-970a-9ce5cfcd9f55

📥 Commits

Reviewing files that changed from the base of the PR and between 43ec12d and 4eca667.

📒 Files selected for processing (1)
  • ADDING_TRANSLATIONS.md

@asyncapi-bot
Copy link
Copy Markdown
Contributor

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 37
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

Lighthouse ran on https://deploy-preview-5274--asyncapi-website.netlify.app/

…onfig.cjs

CodeRabbit flagged that the docs referenced 'languages' and 'defaultLanguage'
but the actual config file uses 'locales' and 'defaultLocale'. Updated all
references throughout the document to match the real config keys.

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@sonarqubecloud
Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: To Be Triaged

Development

Successfully merging this pull request may close these issues.

docs(i18n): inconsistent i18n config filename in ADDING_TRANSLATIONS.md

2 participants