feat: added translation contribution guide

[dklassic]

Will surely be changed alongside the finalization of the translation workflow.

Some food for thought:

• Encouraging a translation fork and merge a full page pull request only?
• If allow partial translation, then how do we handle it?
• Is it possible to setup a per language terminology file to help with the translation consistency? (Would definitely help but then again we didn't actually use it in back in Crowdin and seems fine.....?)

Todo:

• Add a translation checklist around code translations
• Add a translation pull request template
• Add in i18n specific style guide when needed.

Reference:

• feat: added fr translation for "Why Tauri?" page #1397
• feat: added fr translation for "Why Tauri?" page #1404
• feat: added fr translation for "Why Tauri?" page (test again) #1411

[netlify]

✅ Deploy Preview for tauri-docs-starlight ready!

Name	Link
🔨 Latest commit	c70681f
🔍 Latest deploy log	https://app.netlify.com/sites/tauri-docs-starlight/deploys/64df15b47226710008d361c1
😎 Deploy Preview	https://deploy-preview-1393--tauri-docs-starlight.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[lorenzolewis]

Another point (I'll add it to the hackMD as well): Do we require commit signing for this? We might talk through it with the people we have in the docs call and if it's something we're wanting to entertain then can pull in security to get their input as well.

[lorenzolewis]

Just some general feedback outside of the points you already mentioned.

[lorenzolewis]

I think we also need to provide some guidance for how to write links here. i.e. Absolute vs relative links (absolute is preferred), if you include the locale in a link (I believe so, but might need to double-check that behaviour), how to handle headings (such as #link-to-heading).

One extra thing I can look at is adding in a link validator (such as https://github.com/HiDeoo/starlight-links-validator) that we run. This is talked about being added into Starlight natively in the future but I can add this specific integration now if we think we want. That HiDeoo guy is awesome and is very involved in the Starlight ecosystem

[dklassic]

Good point, though not sure if we're supposed to do this here in Translation Guide or in a separate Style Guide.

And yes, I was thinking we'd be adding an action to test on the links when I write up this line. Nice to hear there is already a potential working one and a native one in the future!

[lorenzolewis]

For sure the styles guide (making a note to write one up). Maybe the locale-specific things we could include in the i18n guide and then also link out to the style guide as well?

[dklassic]

Makes sense to me! Let's do that.

[lorenzolewis]

Draft PR for link validation: #1395

There's some upstream issues that I listed in that one that we'll need to resolve before we can merge that in, but the maintainer is very responsive so I don't think it will be a blocker for long.

[lorenzolewis]

@dklassic I think we should also have some guidelines around code translations as well. i.e. do we want code comments to be translated or not.

I know upstream is working on building out a more robust code block component (withastro/starlight#461) using https://github.com/expressive-code/expressive-code, so maybe it's better to specify no translations in code blocks until that gets in place and we know what it looks like?

I don't think it will actually have an impact on the content of the code blocks, it will just be a way to specify meta-info after the opening "```" code block ticks. But maybe better to wait until that lands just to be on the safe side.

[dklassic]

Might be good to have a checklist on these stuffs. Let me link Github doc's own translation guide here to be referenced later:
https://github.com/github/docs/blob/main/contributing/translations-for-translators.md

[lorenzolewis]

Might be good to have a checklist on these stuffs. Let me link Github doc's own translation guide here to be referenced later: https://github.com/github/docs/blob/main/contributing/translations-for-translators.md

That's a really good point. Do you think it'd fit nicely in the TRANSLATING.md file and we can easily add to it as we go along? I do have CI to automatically run pnpm format on commit plus we can catch if a build fails with the Netlify status, so I think we're in decent shape with automation on this front, just would be good to include those common things in the guide.

[lorenzolewis]

I think if we can get all those changes added to the file then this looks good to merge in to me. We can always add on to it as we go along and learn

[dklassic]

Finished writing guidelines. I hope it's not too intimidating.

As for i18n specific styling guide, I haven't thought of anything specific for now. We can probably add it in later after a general styling guide has been made.

[lorenzolewis]

Just a few tweaks, will go ahead and commit those and get this merged in

[lorenzolewis]

Thank you so much @dklassic ! I'll get this merged, update a few pages to be i18n ready, and will enable maybe Chinese and Spanish locales to start slowing opening this up. I'll give a shout to flapili on Discord to see if they're interested in doing a run-through for a French translation to give any feedback.