docs: ko: complete _toctree.yml#22581
Merged
sgugger merged 1 commit intohuggingface:mainfrom Apr 5, 2023
Merged
Conversation
Co-Authored-By: gabrielwithappy <102908949+gabrielwithappy@users.noreply.github.com>
84 tasks
|
The documentation is not available anymore as the PR was closed or merged. |
Contributor
Author
|
Here's the preview screenshot: Yellow highlighted items are complete. Hence, they do not have May you please merge this, Mr. @sgugger ? Thank you so much for your support 🙏💕 |
Contributor
|
I think this PR is a good idea to avoid wrong depth mistakes or yaml syntax errors |
gabrielwithappy
approved these changes
Apr 5, 2023
Contributor
gabrielwithappy
left a comment
There was a problem hiding this comment.
It looks good to me.
I think this PR will help to avoid wrong depth mistakes or yaml syntax errors
5 tasks
novice03
pushed a commit
to novice03/transformers
that referenced
this pull request
Jun 23, 2023
Co-authored-by: gabrielwithappy <102908949+gabrielwithappy@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

What does this PR do?
From our first week in localizing the documentation, we came across issues and git conflicts with
_toctree.yml.This PR updates the
_toctree.ymlfile for translations, making it easier for translators to locate the correct files to translate without worrying about the yaml formatting. Each document title now has(<in translation phrase>)added in front of it and the "local" key has been changed toin_translation.Translators can now use this scaffold by following these steps:
localvalue by copy & pasting directly from the same line number inen/_toctree.yml.titlevalue by replacing the(<in translation phrase>) <english title>with the translated title of each document.By using this updated scaffold, translators will be able to easily identify the correct files to translate, minimizing the time spent on formatting and file location issues. We hope that this will streamline the translation process and make it more accessible to our community.
Initial language starters can recreate this scaffold by following these steps:
_toctree.ymlfile from theenfolder.ko,fr,de).in_translation.mdxfile in the desired language.local: .*withlocal: in_translation.title:withtitle: (<in translation phrase>)where the phrase is preferrably in the desired language. For example, in Korean the phrase is "번역중"By taking the initial time to create this scaffold for your language, you will greatly reduce fellow language speakers' yaml formatting issues in the long run.
Part of #20179
Before submitting
Pull Request section?
to it if that's the case.
documentation guidelines, and
here are tips on formatting docstrings.
Who can review?
Team HuggingFace: @sgugger, @ArthurZucker, @eunseojo May you please review this PR?
Team PseudoLab: @0525hhgus, @kihoon71, @sim-so, @gabrielwithappy, @HanNayeoniee, @wonhyeongseo, @jungnerd May you please review this PR?