blue-build / website

Website that hosts BlueBuild documentation.
https://blue-build.org/
Apache License 2.0
9 stars 6 forks source link

Docs: Add suport for multiple languages #64

Open arejula27 opened 1 month ago

arejula27 commented 1 month ago

Add support for multiple languages. The idea should be to provide a way to let people contribute to the translation of the webpage

xynydev commented 1 month ago

Starlight has built-in support for internationalization, which would make this pretty straightforward to implement for the main documenation pages: https://starlight.astro.build/guides/i18n/ Adopting translation for module reference pages would be slightly more complicated, but probably possible eventually.

However, my main concern is the maintenance prospects of multi-language documentation. I am not committed to maintaining and reviewing translations of the documentation. A trusted maintainer proficient in said language would be needed for every language variant to effectively review the translations and keep them up-to-date. I'd rather have English-only documentation than outdated and possibly misleading documentation in other languages. Having the translated documentation be part-English to remedy the incompleteness of translations is a possible band-aid solution, I guess.

If you (or anyone) is interested in contributing and maintaining translations of some of the more static key documentation pages as a pilot, I wouldn't be opposed to that. And of course in the future when / if the project grows and stabilizes, internationalized documentation will become a more feasible and desirable thing to do.

arejula27 commented 1 month ago

Let's wait then