Translate docs to multiple languages

[alvarosabu]

Description

As a developer using TresJS I would like to have documentation available in my native language

This ticket is meant to keep track of the progress of multiple PRs to translate Tres docs:

• Enable i18n and add Spanish docs done Add i18n to Tresjs documentation #123 docs: enable multi language #534
• Chinese translations @enpitsuLin docs: chinese translations #550
• German @DennisSmuda docs: german translations #548
• Polish @Dekier docs: polish translation #546
• French @AminGtt docs: french translation #555

Feel free to comment below if you would like to add your language and help us translate the docs.,

Suggested solution

Create a branch docs/translation-<language-unicode> and a PR similar to #534 with the following steps:

1. Add a <language-unicode>.ts inside docs/.vitepress/config ex: zh.ts (copy the en.ts which is the original and then translate only what's needed.
2. Remember to add the code prefix route to all the links on this file, ex link: /guide/ -> link: /zh/guide
3. Add to config to docs/.vitepress/config/index.ts like this:

export default defineConfig({
  ...sharedConfig,
  locales: {
    root: { label: 'English', lang: 'en-US', link: '/', ...enConfig },
    es: { label: 'Español', lang: 'es-ES', link: '/es/', ...esConfig },
    /* zh: { label: '简体中文', lang: 'zh-CN', link: '/zh/', ...zhConfig }, */
  },
})

4. Create a folder with the language code (ex: zh) inside docs/, this is where the translations will live, then start translating the files using the same structure as on the docs root, like this:

docs/advanced/extending.md --> docs/zh/advanced/extending.md

Alternative

No response

Additional context

No response

Validations

• I agree to follow this project's Code of Conduct
• Read the Contributing Guidelines.
• Read the docs.
• Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.

[DennisSmuda]

@alvarosabu I'll shoot a PR for german translations this weekend 👍

[offskip-dave]

@alvarosabu @DennisSmuda
I was a little bit too late with the German translations, but glad to see that it is being done 👍

[enpitsuLin]

@alvarosabu I've also started trying to translate it into Chinese. It's time to introduce more Chinese Vue developers to this awesome library! 🎉

[alvarosabu]

@alvarosabu @DennisSmuda I was a little bit too late with the German translations but glad to see that it is being done 👍

You can still participate, let me know and I will add you to the doc team, the only thing I would ask if you could coordinate with @DennisSmuda inside the PR which pages to translate, one suggestion would be doing a todolist on the description and assign the pages between the contributors.

Thanks a lot for this

[offskip-dave]

@alvarosabu @DennisSmuda I was a little bit too late with the German translations but glad to see that it is being done 👍

You can still participate, let me know and I will add you to the doc team, the only thing I would ask if you could coordinate with @DennisSmuda inside the PR which pages to translate, one suggestion would be doing a todolist on the description and assign the pages between the contributors.

Thanks a lot for this

@alvarosabu
Got it. Seems like a good approach to me.

@DennisSmuda
Let me know if you need help with this.

[DennisSmuda]

@offskip-dave - I only have examples and directives left to do - if you wanna take on one of these from me, sure 👍

[DennisSmuda]

@offskip-dave I think I'm done - I'd appreciate someone to read over it though 🙏

[offskip-dave]

@offskip-dave I think I'm done - I'd appreciate someone to read over it though 🙏

Ok, I will do!

[X-smart]

I'm glad to work together with @enpitsuLin on this translation.🤗

Hopefully, Tres can help more people get their work done.

[offskip-dave]

@alvarosabu
I know you would prefer a native speaker, but I have lived close to 10 years in Japan and I feel relatively confident in Japanese, so I think I could give a shot at Japanese translations and have a native speaker proofread it, what do you think?

[Laeti-dev]

@alvarosabu
Hi there ! I see that @AminGtt has started working on french translation. Can I help somehow ?

[AminGtt]

Hey @Laeti-dev ✋ I already did some pages but didnt open a PR, I will do it tonight and then we can split what is still waiting to be done. I will also appreciate a review once everything will be done. I keep you posted a bit later in the day :)

[Laeti-dev]

Hello @AminGtt ! I'll have some free time this week, if you could just open a PR with your work, I could start with a proof reading and work on a page ;) Talk to you soon

[alvarosabu]

@alvarosabu I know you would prefer a native speaker, but I have lived close to 10 years in Japan and I feel relatively confident in Japanese, so I think I could give a shot at Japanese translations and have a native speaker proofread it, what do you think?

Absolutely! Feel free to create a PR for Japanese! I think I know who could help us. 😊

[alvarosabu]

Hi @Laeti-dev @AminGtt let me know if I can support you somehow, super happy to see everyone collaborating to get Tres translated to everyone. Thank you 🙏🏻

[AminGtt]

Hey @Laeti-dev! Sorry for not contacting you directly before but I am not able to mention you on the PR directly, I opened it the day we talked. You can found it here: #555
Everything is detailed and should not be difficult. Ping me if you need anything,
Cheers

[LucaArgentieri]

Italian translations WIP 👷‍♂️ #654, setup ready 👍

[offskip-dave]

@alvarosabu
Sorry for the delay with the Japanese translations, but I think I will have them ready within the next 2 or so weeks.

[alvarosabu]

Hi @offskip-dave no rush at all, I'm really happy you are working on them 💚