Hey. I would like to offer my help in the xod.io website internationlistion. I could translate into my native languge - polish
There is a “Translate the docs” section on this page: Contributing to XOD — XOD
The case is that the section you gave is not exact enough. The site and docs are based on separate files and I’m not sure if I translate them then if by the pull request they won’t overwrite the orginal ones.
That why the instruction need precising to make the trabslation work easier
Hi @mcgiwer,
Great to hear that you can help with the translation of the docs. When you browse through the xod-docs repository you will see that there is a directory for each article. For example, the following directory contains the first tutorial:
https://github.com/xodio/xod-docs/tree/master/docs/tutorial/001-hello
In this directory, README.md is the original (English) version of the article. There is also a file called RU.md, which is the Russian translation. Your translation of the article would go into a file called PL.md.
Hope this helps.
@wayland I understood this part. But what if there is more then one file to translate in a folder ? This is not explained
OK, I see the issue now. For the contributing, guide and reference articles there is a single markdown file (README.md) to be translated.
However, for the tutorial articles there are two markdown files: README.md and before-1st-h2.md. The tutorial README.md files are autogenerated from the welcome-to-xod project using generate-tutorial-docs.js. I think the before-1st-h2.md file is manually created for the Fritzing scheme, but I may be wrong. I agree that for the tutorials there doesn’t seem to be guidance on how to do the translations.
As you are probably aware, XOD is in a state of flux (see That’s all. XOD is looking for for a new owner), so it may take some time to get instructions on how to translate the tutorials. Also, I’m not sure how long it will take for your translated articles to go live. If despite these uncertainties you would still like to contribute, you could start by translating the guide and reference articles.