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

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

Open davidturnbull opened this issue 1 month ago • 4 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 Django.

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

Hi @davidturnbull , I'm comfortable with Django and would love to write this integration guide. Please assign me, and I'll get started by following the structure of the existing guides as requested.

gautamk01 avatar Oct 30 '25 03:10 gautamk01

Hi @davidturnbull! I’d love to take this on. I’m a good fit because I’ve shipped Django apps in production and have experience writing step-by-step integration docs for dev tools. I’ll follow the format and depth of your existing framework guides and ensure the tutorial is fully testable end-to-end.

Planned steps:

  • Scaffold a minimal Django app and wire a tiny i18n layer that reads Lingo.dev-compiled JSON bundles.
  • Use Lingo.dev CLI to initialize locales, add languages, and compile messages.
  • Demonstrate key patterns: message keys, formatting params, a locale switcher, and session persistence.
  • Provide production tips, troubleshooting, and a clean test path.
  • Open a PR with the guide in a Markdown file per your workflow.

I’ve started with a complete draft and will iterate based on your feedback.

manasdutta04 avatar Oct 30 '25 04:10 manasdutta04

Assigning this to you @gautamk01

@manasdutta04 and @SatishKumar620 please keep this in mind:

Image

sumitsaurabh927 avatar Oct 31 '25 19:10 sumitsaurabh927

“Hi — I’m a new contributor. I’d like to work on this issue (create a Django CLI integration guide). Thanks!”

Ekansh0718 avatar Nov 04 '25 06:11 Ekansh0718