lingodotdev
docs: create a Lingo.dev CLI integration guide for Vue.js
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 Vue.js.
The guide should:
- Follow the same general flow, scope, and structure of existing guides
- Include i18n setup instructions for a fresh Vue.js project
- Use vue-i18n to render translations: https://vue-i18n.intlify.dev/guide/introduction
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:
- Create a pull request for the current repo.
- In the PR, include a Markdown file that contains the integration guide (e.g.,
docs/guide.md). - We'll review the PR, working with you to get the guide into the best state possible.
- If we publish the guide on the website, we'll include a byline in the documentation that links to your GitHub profile.
- 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.)
Hi Lingo.dev team, @davidturnbull I'm interested in contributing an integration guide to Vue.js your CLI documentation library. I've reviewed the existing guides (Godot, Mintlify, Laravel, iOS, and React Native Expo) and understand the structure, scope, and workflow you follow.
Hey @davidturnbull, I’d like to help out with the documentation as my first contribution. Can you please assign it to me?
