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

docs: create a Lingo.dev CLI integration guide for Unreal Engine

Open davidturnbull opened this issue 1 month ago • 9 comments

Context

We're building a library of integration guides that show developers how to use Lingo.dev CLI with popular frameworks and platforms. Each guide is intended to be a complete, hands-on tutorial that takes someone from zero to having a working multilingual application.

Task

Create a Lingo.dev CLI integration guide for Unreal Engine.

The guide should follow the same general flow, scope, and structure of existing guides.

Example guides

These are some examples of existing guides:

  • Godot: https://lingo.dev/en/cli/frameworks/godot
  • Mintlify: https://lingo.dev/en/cli/frameworks/mintlify
  • Laravel: https://lingo.dev/en/cli/frameworks/laravel
  • iOS: https://lingo.dev/en/cli/frameworks/ios
  • React Native (Expo): https://lingo.dev/en/cli/frameworks/react-native-expo

Caveat: Merging PRs

Our documentation content lives in an internal repo. This means if you open a pull request for an integration guide, we can't merge it directly. Instead, we use the following workflow to ensure everyone receives credit for their work:

  1. Create a pull request for the current repo.
  2. In the PR, include a Markdown file that contains the integration guide (e.g., docs/guide.md).
  3. We'll review the PR, working with you to get the guide into the best state possible.
  4. If we publish the guide on the website, we'll include a byline in the documentation that links to your GitHub profile.
  5. Once the documentation has been published, we'll close the PR with a comment that references the document.

Testing

Be sure to test the complete guide by carefully following all of the steps. (This is the most time-consuming part.)

davidturnbull avatar Oct 30 '25 03:10 davidturnbull

Hey @davidturnbull, I’d like to help out with the documentation as my first contribution. Can you please assign it to me?

gagan052 avatar Oct 30 '25 05:10 gagan052

@gagan052 do you wanna work on this?

sumitsaurabh927 avatar Oct 31 '25 18:10 sumitsaurabh927

@gagan052 do you wanna work on this?

Hey can i work on this?

mannubaveja007 avatar Oct 31 '25 19:10 mannubaveja007

Hi @sumitsaurabh927, Yes, I’d like to work on this issue. Please assign it to me. I’ll make sure to follow the contributor guidelines and keep you updated on my progress. 😊

gagan052 avatar Nov 01 '25 08:11 gagan052

Sure @gagan052 assigned it to you, have fun!

@mannubaveja007 Gagan had asked to be assigned first so he will be given the first chance but feel free to look around to find any issues or open any bug/feature/issue if want to.

We'll also be creating more issues for all of you to contribute.

sumitsaurabh927 avatar Nov 03 '25 19:11 sumitsaurabh927

Thanks, @sumitsaurabh927 Excited to work on this issue. I’ll start researching and share an initial draft soon.

gagan052 avatar Nov 03 '25 19:11 gagan052

Hi @sumitsaurabh927 , 👋

I’ve completed and submitted the Lingo.dev CLI integration guide for Unreal Engine as outlined in issue #1341. The guide follows the format of existing integration docs and includes full testing with a working Unreal Engine localization setup.

Could you please review the PR when you get a chance? Here’s the link: #1525

Thank you for your time and feedback! 🙏

Best regards, Gagan Saini (@gagan052)

gagan052 avatar Nov 04 '25 09:11 gagan052

Let's wait for @davidturnbull to review this.

Thanks for your contribution! 🎉

sumitsaurabh927 avatar Nov 04 '25 21:11 sumitsaurabh927

hey @sumitsaurabh927 I had created this PR again as said by @maxprilutskiy can you please review it.

gagan052 avatar Nov 16 '25 12:11 gagan052