Skip to content

docs: expand i18n README - #1565

Draft
Himavarshit18 wants to merge 1 commit into
flatcar:mainfrom
Himavarshit18:docs/expand-i18n-readme
Draft

docs: expand i18n README #1565
Himavarshit18 wants to merge 1 commit into
flatcar:mainfrom
Himavarshit18:docs/expand-i18n-readme

Conversation

@Himavarshit18

Copy link
Copy Markdown

Replaces placeholder text in frontend/src/i18n/README.md with actual i18n development documentation. Also removes the circular reference by deleting frontend/docs/development/i18n.md (which was just a TODO).

This helps frontend contributors understand Nebraska's internationalization workflow by providing documentation next to the i18n code.

Changes

Modified: frontend/src/i18n/README.md
Deleted: frontend/docs/development/i18n.md

Testing

Verified:

  • All paths exist (locales/en/, common.json, etc.)
  • Import uses react-i18next (correct package)
  • Translation keys exist in codebase (common|confirmation_prompt)
  • npm run i18n command exists in package.json
  • Namespace separator is | (per config.ts)

Replaces placeholder text in frontend/src/i18n/README.md with actual
i18n development documentation. Also removes the circular reference by
deleting frontend/docs/development/i18n.md (which was just a TODO).

Changes:
- Adds code examples for useTranslation hook
- Documents the npm run i18n command
- Lists translation file namespaces
- Removes docs/development/i18n.md TODO file

This helps frontend contributors understand Nebraska's internationalization
workflow by providing documentation next to the i18n code.

Signed-off-by: Himavarshit18 <himavarshitreddyk@gmail.com>
@Himavarshit18 Himavarshit18 changed the title docs: expand i18n README with usage examples docs: expand i18n README Aug 11, 2026
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