internationalisation for nuxt.com
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 457
- Forks
- 272
- Avg merge
- 13h 33m
- Merged PRs (30d)
- 23
Description
we'd love to have the nuxt.com docs available in translations for users across the world
although this has been a plan for some time, and was indeed the case in nuxt v2, we're still not there with v3 docs
Related issues: https://github.com/nuxt/nuxt/issues/19926, https://github.com/nuxt/nuxt/issues/21926, https://github.com/nuxt/nuxt/discussions/16054, https://github.com/nuxt/nuxt.com/issues/1448 and https://github.com/nuxt/translations/discussions/4 (private repo - relevant content copied into this issue).
Key requirements
- needs to be performant and not regress performance of the documentation
- translations need to remain always in sync, falling back to english text if required
- needs to allow community contribution
Translation and sync automation
Documentation sources currently come from https://github.com/nuxt/nuxt.com, https://github.com/nuxt/nuxt and https://github.com/nuxt/examples. upstream changes need to be localisable, and trigger call for updates for translators, without blocking the documentation.
It would be nice to consider exploring LLM triggers for translation (see for example the way https://github.com/formkit uses ai in the process of building their documentation website) - at least for 'fallback' content.
👉 See https://github.com/nuxt/nuxt/discussions/29949 for a proposal
Building a team
We've had many offers of help for translating the docs, and we'll need to build a team - but first we need to add the infrastructure to make updating translations possible.
So initially I would love for someone or a small group to take on the task of building up the automation + integration into the nuxt/nuxt.com repository, before we move ahead to create a bigger team of translators.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the proposal in nuxt/nuxt discussions/29949, then inspect how documentation sources from nuxt/nuxt.com, nuxt/nuxt, and nuxt/examples are currently built and updated. Done means a performant translation workflow is integrated with nuxt/nuxt.com, keeps translations synchronized with English while providing fallback text, and supports community contributions without blocking documentation updates.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- nuxtjs, typescript
- Domain
- documentation, internationalization, tooling
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100