transformers icon indicating copy to clipboard operation
transformers copied to clipboard

UPDATE Documentation for #TRANSLATING.md Documentation into Multiple Languages.

Open anshumangahlot opened this issue 1 year ago • 0 comments

This PR introduces a guide for translating the Transformers documentation into multiple languages as part of the project’s effort to make machine learning more accessible globally.

Key Changes:

  • New Translation Instructions: Added detailed step-by-step instructions for contributing translations, covering everything from opening issues to forking the repository, and translating relevant files.

  • File Organization: Included a guide on how to copy the English documentation to a new language folder using ISO 639-1 or ISO 639-2 language codes.

  • _toctree.yml Guidance: Provided instructions on editing or creating the _toctree.yml file to correctly render the documentation’s table of contents for the new language.

  • Collaboration Encouragement: Emphasized the importance of collaboration, inviting contributors to share glossaries and tag team members for assistance.

Files Modified:

  • Added docs/source/translation_guide.md: This file contains the full translation guide, with detailed instructions on getting started, collaborating, and submitting translations.

Additional Notes:

  • The guide encourages new contributors to open issues before starting a translation, ensuring no duplicate efforts.

  • Resources and tips for effective translation are included to help users maintain consistent terminology.

  • I’ve added links to relevant documentation, including language code references and GitHub commands.

anshumangahlot avatar Oct 17 '24 16:10 anshumangahlot