Hello and welcome to the Solidity documentation translations GitHub organization! Great to have you here. 😊
In this org, we coordinate all community-driven translation efforts.
Please note that the Solidity team can give no guarantees on the quality and accuracy of the translations provided. The translations are meant to lower the entry barriers for non-English speaking developers and hence will allow a broader set of developers from all over the world to get to know Solidity. However, the English reference version is and will remain the only officially supported version by the Solidity team and will always be the most accurate and most up-to-date one. When in doubt, always refer to the English (original) documentation.
Before we get started, please make sure to read this guide carefully.
By uniting all translation efforts in this repository we aim to…
- Get a broader set of eyes and contributors involved in the translation process.
- Establish quality standards and best practices.
- Help each other and better leverage synergies across the different language translation teams.
After carefully evaluating different options, we decided in favor of keeping the technicalities of the translation process up to the individual contributors and decided against using a translation tool.
However, in order to make things easier for the contributors and assure some sort of standard, we are proposing to follow the rough process which is outlined below, respecting the translation checklist and working in a translation team of min. 2 people.
To start with a new language, adhere to the following process:
Find at least one other contributor to join you in being the maintainer (main contributor and owner) of this language. Being the maintainer of the translation requires you to organize the translation efforts for this respective language, assure quality and accuracy and make sure translations are kept in sync and are on an up-to-date level. You find an overview and tips in the maintainer guide.
If you don’t know of any other translators that want to join your language, feel free to create a topic in the documentation category of the Solidity forum to find more contributors.
Once you have your team of min. 2 contributors, create a PR to the langs folder consisting of file {lang-code}.json including the English name of the language, the language code and a list of maintainers.
For example:
{
"name": "German",
"code": "de",
"maintainers": ["franzihei", "chriseth"]
}
Once the PR is accepted you will receive an invitation to join the solidity-docs GitHub organization.
As a next step, create a new repository in this organization. The name of the repository should consist of the language code followed by the English name of the language, e.g. for a German translation the repository would be called: de-german.
Then, go to the current Solidity repository and copy the docs folder content into your language repository.
That's it, now you can start translating! Make sure to create an issue with the translations progress checklist in your repo to track the progress and please follow the recommendations outlined in the maintainer guide.
Once your translations is advanced and you have checked the first part of the translations progress checklist, please let us know and we will consider adding your translation to the language flyout menu of the offical Solidity documentation!
Optimally, we would like to have a bot similar to the reactjs-translation-bot, which would create PRs with new content that needs to be translated everytime the original documentation is updated. Please reach out to us if you can help us setting this up!
Big kudos go out to the ReactJS translations team repository and the ethereum.org translation team, which both inspired us with their resources and advised on setting up this process.