Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

internationalisation for nuxt.com #1711

Open
danielroe opened this issue Nov 17, 2024 · 6 comments
Open

internationalisation for nuxt.com #1711

danielroe opened this issue Nov 17, 2024 · 6 comments
Labels
enhancement New feature or request roadmap

Comments

@danielroe
Copy link
Member

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: nuxt/nuxt#19926, nuxt/nuxt#21926, nuxt/nuxt#16054, #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 nuxt/nuxt#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.

@shayr1
Copy link

shayr1 commented Nov 17, 2024

I am thinking that it might be beneficial to use some type of DB or use @nuxtjs/i18n with server side translations, so that it can be easily changed. I see that some of the routes I pre-rendered (from looking at nuxt.com nuxt.config.ts file), so of course that would need to be taken into account.

@ikxin
Copy link

ikxin commented Nov 20, 2024

I started maintaining the Nuxt Simplified Chinese documentation six months ago. The current method I use is to translate simultaneously across the three repositories: nuxt/nuxt, nuxt/nuxt.com, and nuxt/examples, merging upstream updates using git diff to keep the documentation translation up to date.

For more details, you can check the Nuxt Chinese documentation repository https://github.com/zhcndoc/nuxt

@ikxin
Copy link

ikxin commented Nov 20, 2024

If the Nuxt official has a better translation process, I am willing to join in contributing to the translation and synchronize all existing translation results to the official Nuxt translation.

Nuxt Chinese documentation: https://nuxt.zhcndoc.com

@tidan-16
Copy link

It seems like the main nuxt.com website could be translated with the nuxt/i18n library but the main "problem" would be translating the nuxt docs and also the nuxt examples which are both using nuxt/content.

@ikxin
Copy link

ikxin commented Nov 20, 2024

It seems like the main nuxt.com website could be translated with the nuxt/i18n library but the main "problem" would be translating the nuxt docs and also the nuxt examples which are both using nuxt/content.

nuxt/i18n can use different routes to point to different files, such as /docs/getting-started/installation and /zh-cn/docs/getting-started/installation. I think the challenge lies in how to keep both in sync, and I'm not sure if https://github.com/lunariajs/lunaria can handle this task.

@cernymatej
Copy link

Chiming in, I'd be happy to help with anything necessary—either translation or building the infrastructure around it. Feel free to ping me when needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request roadmap
Projects
None yet
Development

No branches or pull requests

5 participants