ava-labs/avalanche-docs

Support for other languages

Closed this issue · 13 comments

Current Behavior

The documentation website currently includes a dropdown to select language but our only supported language is English. This is causing confusion for users and preventing us from supporting devs from our target markets/regions.

Expected Behavior

We need to add a service that translates our documentation into other languages. This will improve the user experience and ensure that the documentation is clear and reached a wider developer audience.

Steps to Reproduce

Visit the documentation website.
Observe the presence of the language selection dropdown in the navbar.

Proposed Solution

Implement a service to translate our documents into Chinese, Korean, and Spanish. In the future we should add even more languages. Get started in the docusaurus documentation here: https://docusaurus.io/docs/i18n/introduction.

Alternative: We've been working on a solution to translate support and dev docs into Korean and Japanese. Here is the proposal and cost to translate the entire dev docs to Korean and Japanese.

Crowdin:

-requires manual hiring of translators
-also had issues w/past translations due to crypto-specific terms
-Requires more hands-on updates for each sync/update, including a PR for each update on Dev docs

Smartling:
-No PRs required to update dev docs, just sync the site using their dashboard to have it begin any translation updates
-They provide all the translators, and no extra steps in hiring are needed
-Base platform costs and annual costs higher

We can bring over the translated library from Crowdin to Smartling also to help reduce the costs as some words are already translated from Core ext/mobile project.

See previous PR: #512

@yulin-dong did this PR result in a full chinese translation? Why can't we see it now?

@yulin-dong did this PR result in a full chinese translation? Why can't we see it now?

No, it was just a prototype to go through the process of i18n by docusaurus with Crowdin. You can see the preview link at https://3bd07002.avalanche-docs.pages.dev/zh-cn/

@meaghanfitzgerald Will it be ok, if a whole new site is created with translated content, like vue js or vite js documentation?

@Wholesomebruh Ideally it would be implemented within our own documentation site, similar to how webdriver.io has done it.

@meaghanfitzgerald Please assign it to me, I'm working on it.

@Wholesomebruh any updates on this? any issues I can help with?

Thanks for asking, I manually translated the docs, which can later be synced with smartlings. Currently , I am implementing i18n from docusaurus itself which will be free of cost , facing some issues with broken link. Will raise a PR , once I'm done debugging.

@Wholesomebruh any more updates? i18n would be a big improvement

Hello so I would like to contribute in it for multiple languages using i18n and I have experience in it I implemented this type of localization for push protocol (https://push.org/) and got bounty. so can we discuss on it

@anuragasawa20 I see the home page is translated but their developer documentation is still only available in english https://push.org/docs/

yeah I have done for their home Page so I can do it for both our home page and Docs using i18n

This was addressed with PR #1564 by adding spanish support