Skip to content

UPDATE Documentation for #TRANSLATING.md Documentation into Multiple Languages.(Changes made) - #34226

Merged
stevhliu merged 4 commits into
huggingface:mainfrom
anshumangahlot:main
Oct 30, 2024
Merged

stevhliu merged 4 commits into
huggingface:mainfrom
anshumangahlot:main

Conversation

@anshumangahlot

Copy link
Copy Markdown
Contributor

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.

@Rocketknight1

Copy link
Copy Markdown
Member

cc @stevhliu

@stevhliu stevhliu left a comment •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, thanks for updating! Left a few comments about formatting, otherwise LGTM! 🤗

Make sure to also rebase on main to fix the failing CI test

Comment thread docs/TRANSLATING.md Resolved
Comment thread docs/TRANSLATING.md Resolved
Comment thread docs/TRANSLATING.md Resolved
Comment thread docs/TRANSLATING.md Resolved
Comment thread docs/TRANSLATING.md Resolved
Comment thread docs/TRANSLATING.md Resolved
anshumangahlot and others added 3 commits October 30, 2024 23:55
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
@anshumangahlot anshumangahlot changed the title UPDATE Documentation for #TRANSLATING.md Documentation into Multiple Languages. UPDATE Documentation for #TRANSLATING.md Documentation into Multiple Languages.(Changes made) Oct 30, 2024
@HuggingFaceDocBuilderDev

Copy link
Copy Markdown

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@stevhliu
stevhliu merged commit 405b562 into huggingface:main Oct 30, 2024
BernardZach pushed a commit to BernardZach/transformers that referenced this pull request Dec 5, 2024
…Languages.(Changes made) (huggingface#34226)

* Update TRANSLATING.md

* Apply suggestions from code review

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* Update TRANSLATING.md

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants