Skip to content

docs: updated translations guide and l10n config#830

Open
vishnunandan555 wants to merge 1 commit into
AOSSIE-Org:devfrom
vishnunandan555:dev
Open

docs: updated translations guide and l10n config#830
vishnunandan555 wants to merge 1 commit into
AOSSIE-Org:devfrom
vishnunandan555:dev

Conversation

@vishnunandan555

Copy link
Copy Markdown

Description

This PR updates the outdated TRANSLATIONS.md guide and cleans up the redundant configuration in l10n.yaml to match the current Flutter localization setup.
I discovered these issues while working on Malayalam localization in #719.

Fixes #738

Summary of Changes

  1. Removed Outdated Steps: Removed instructions to manually add locales in main.dart or l10n.yaml because flutter gen-l10n automatically scans all app_*.arb files in the directory to compile locale support dynamically.
  2. Cleaned up config: Removed the unused/ignored supported-locales block from l10n.yaml to avoid confusion.
  3. Updated Supported Languages & Reference Tables: Updated the documentation to show all 10 currently supported regional languages
  4. Improved paths: Clarified that untranslated.txt is auto-generated in the project root directory rather than lib/l10n/ to save time for new contributors.
  5. Updated Language Codes Reference: Added reference tables for all currently supported languages and other potential future additions.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking CHANGE which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (does not change functionality, e.g. code style improvements, linting)
  • Documentation update

How Has This Been Tested?

  • Verified by running the localizations code generator and ensuring the app compiles and all existing tests pass successfully:
  • Executed flutter gen-l10n and confirmed the localizations are correctly compiled for all 10 regional languages.
  • Executed flutter test and confirmed all unit/widget tests pass successfully.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

Maintainer Checklist

- Corrected the supported languages list to reflect all 10 target regional languages
- Added accurate translation completeness statistics for each language
- Removed the redundant and ignored `supported-locales` block from l10n.yaml
- Updated instructions to remove outdated manual registration steps for l10n.yaml
- Clarified that `untranslated.txt` is generated in the project root directory rather than lib/l10n/
- Revised the Language Codes Reference tables to list currently supported and potential target languages
@vishnunandan555 vishnunandan555 requested a review from M4dhav as a code owner June 23, 2026 11:09
@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2d4a0f5a-b338-441f-b9cc-52ce9d0d1e21

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ 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.

@github-actions

Copy link
Copy Markdown
Contributor

🎉 Welcome @vishnunandan555!
Thank you for your pull request! Our team will review it soon. 🔍

  • Please ensure your PR follows the contribution guidelines. ✅
  • All automated tests should pass before merging. 🔄
  • If this PR fixes an issue, link it in the description. 🔗

We appreciate your contribution! 🚀

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant