Translating the documentation

Symbol’s awesome community actively localizes the contents of this site, and we’re endlessly thankful for that.

Symbol Developer Documentation uses Transifex, a collaborative localization platform, to manage translations and make the process participative. Follow this instructions to start submitting your contributions.

Getting started for translators

  1. Create a new Transifex account here.
  2. Join symbol-docs team. Click on Help Translate “symbol-docs” button on the right side of the header, selecting the language you want to contribute.
  3. Wait until the translation coordinator will approve your request. Once accepted, you will receive an email. At this moment, you will be able to start translating the docs.
  4. Once you have joined the team, you can contribute either translating new contents or reviewing translations recommended by other users.


Is the first time you use Transifex? We recommend you to read the following guides from Transifex’s documentation:

Notes for developers

This guide explains how to interact with Transifex service using the transifex-client tool.

Pull latest files

Follow these instructions to download the latest translations from Transifex.

  1. Install transifex-client.
 pip install transifex-client
  1. Download the latest translated files. Replace <lang> with your language code.
 tx pull --mode onlyreviewed --language <lang>
  1. Compile the docs for the target language.


 make -e SPHINXOPTS="-D language='<lang>'" livehtml


 set SPHINXOPTS=-D language=<lang>
.make.bat html

Push new literals

Follow these instructions to publish updated source literals to Transifex.


You will need explicit permissions from the Transifex project coordinator to push source files.

  1. Generate the literals. For each documentation file, a .po file will be created under build/gettext.


 make gettext


 .make.bat gettext
  1. Push the source literals to Transifex.
 tx push --source

Submit your changes into the symbol-docs repository.