lingo.dev icon indicating copy to clipboard operation
lingo.dev copied to clipboard

#1341 Issue: docs: create a Lingo.dev CLI integration guide for Unrea…

Open gagan052 opened this issue 1 month ago • 4 comments

Summary

Add a complete Unreal Engine 5 integration guide for the Lingo.dev CLI to docs/guide.md to streamline .po translation, .locres compilation, and runtime culture switching.

Changes

  • Add “Unreal Engine – Lingo.dev CLI Integration Guide” to docs/guide.md:1–158
  • Document Unreal Localization Dashboard setup (gather/export/import)
  • Provide i18n.json for .po translation buckets using [locale]
  • Include CLI flow ( npx lingo.dev@latest login and run )
  • Explain .locres compilation and runtime culture switching (Blueprint and C++)
  • Add troubleshooting and an end‑to‑end checklist for verification

Testing

  • Documentation-only change; business logic tests are not applicable

  • Manual validation steps performed:

    • Create widget with translatable text ( Hello, world )
    • Configure Game target; run Gather and export en.po
    • Add i18n.json and run npx lingo.dev@latest login → npx lingo.dev@latest run
    • Import es.po in Unreal and Compile .locres
    • Switch culture to es in PIE and verify localized UI
  • All manual validation steps pass locally

Visuals

  • N/A (documentation-only change; no UI/UX changes in the app)

Checklist

  • Changeset added (not needed; docs-only)
  • Tests cover business logic (N/A for docs; manual validation included)
  • No breaking changes Closes #1341

File Reference

  • docs/guide.md:1–158

gagan052 avatar Nov 16 '25 12:11 gagan052

@davidturnbull need a review here

sumitsaurabh927 avatar Nov 17 '25 07:11 sumitsaurabh927

@gagan052 there's a merge conflict, please resolve

sumitsaurabh927 avatar Nov 19 '25 04:11 sumitsaurabh927

hey @davidturnbull can you please review this PR .

gagan052 avatar Nov 21 '25 07:11 gagan052

hey @sumitsaurabh927 can you please review this PR.

gagan052 avatar Nov 27 '25 17:11 gagan052

hey @sumitsaurabh927 and @davidturnbull can you please review this PR.

gagan052 avatar Dec 04 '25 18:12 gagan052

Hey @gagan052 since our docs aren't open source as of now, we can't merge this.

However, your contribution still counts.

Thank you!

sumitsaurabh927 avatar Dec 05 '25 09:12 sumitsaurabh927