next-intl
next-intl copied to clipboard
amannn
Support other languages in docs
Discussed in https://github.com/amannn/next-intl/discussions/170
Originally posted by jorgebef January 23, 2023 Hello, I was chatting about the i18n implementation with someone who is Spanish speaking and realised that the documentation is only in English.
It would be nice if the documentation for an i18n library is actually internationalized 😝 I can help with Spanish as I am native Spanish and English. I can help with other languages, but I believe it best to leave it to a native speaker of those languages.
I don't know whether you are interested in going down that route now or whether you would rather wait until the app directory is out of beta?
Hey! Ha, that's a fair point indeed! 😄
Thank you so much for proposing to volunteer! If we add new languages, I'd certainly need help from native speakers as I only speak English and German.
I think for the time being I'd propose to turn this into an issue and to see how many users are interested in this. I think the effort of supporting multiple languages is quite extensive, considering we'd have to translate all the existing content but also to keep it in sync in the future. I think currently this endeavour might be a bit too ambitious, given the current popularity of the library. But it might be something to look into in case the user base grows!
Out of curiosity: Does your colleague not speak English at all? What's his/her experience with other developer documentation? Is there much content available in Spanish?
I briefly tried what the next-intl docs look like if I use Google Translate to turn it into German and I didn't find it too bad TBH. Of course it's not 100% correct, but still helping. Also code samples remain as-is, that's quite good.
Many thanks to everyone proposing to help so far! 🙌 ❤️❤️
Is there a PR for this already?
Not yet. The current situation is that the docs are still a bit in flux, I'm planning to restructure them to be App Router-first.
Therefore I think for now it's a good idea to wait until the docs are reshaped and the dust settles a bit. The docs use Nextra, which has built-in i18n support for content pages.
We should also think about a proper i18n workflow here, to get an overview of which pages have been translated and also when content changes in the future, this should invalidate existing translations to be rechecked. I know that Crowdin has MDX support, so maybe this could be helpful here.
I'll keep this thread updated with the latest information in regard to the docs!
Many thanks to everyone proposing to help so far! 🙌 ❤️❤️
Is there a PR for this already?
Not yet. The current situation is that the docs are still a bit in flux, I'm planning to restructure them to be App Router-first.
Therefore I think for now it's a good idea to wait until the docs are reshaped and the dust settles a bit. The docs use Nextra, which has built-in i18n support for content pages.
We should also think about a proper i18n workflow here, to get an overview of which pages have been translated and also when content changes in the future, this should invalidate existing translations to be rechecked. I know that Crowdin has MDX support, so maybe this could be helpful here.
I'll keep this thread updated with the latest information in regard to the docs!
I completely agree with App Router-first, the official docs (App Router) doesn't give a best practice for MDX internationalization.
If you ever pick this back up, I could help out with Spanish. I have translated some of the Storybook docs earlier this year :)
