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

docs: create a Lingo.dev CLI integration guide for Electron

Open davidturnbull opened this issue 1 month ago • 8 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 Electron

The guide should:

  • Follow the same general flow, scope, and structure of existing guides
  • Use react-intl to render translations

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 , Hope you are doing well. I wanted to contribute to this project so I thought of starting with a documentation contribution.

Can you assign it to me ?

gagan052 avatar Oct 30 '25 05:10 gagan052

Hey @davidturnbull, I am just getting started with open source contribution can you please assign me this issue , to start my journey in open source contribution

ranjithreddykv avatar Oct 30 '25 16:10 ranjithreddykv

Hey @gagan052 do you wanna work on this issue?

sumitsaurabh927 avatar Oct 31 '25 18:10 sumitsaurabh927

can i work on this issue?

mannubaveja007 avatar Oct 31 '25 19:10 mannubaveja007

Hi @davidturnbull , Please check out PR #1500, it includes the complete and tested setup for Electron + Lingo.dev CLI + React-Intl, with all fixes and documentation updates in place.

Everything’s been tested locally and confirmed working as expected.

Athaxv avatar Oct 31 '25 20:10 Athaxv

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

Hey @gagan052 since the PR for this that @Athaxv has created already has had one round of review, I'm assigning this to him. I've assigned you to a couple of other issues where you had commented first.

Have fun! 🎉

sumitsaurabh927 avatar Nov 03 '25 19:11 sumitsaurabh927

No worries, @sumitsaurabh927 Thanks for letting me know and assigning me to other issues — I’ll get started on those right away 😊

gagan052 avatar Nov 03 '25 19:11 gagan052