-
Notifications
You must be signed in to change notification settings - Fork 27.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: ko: complete _toctree.yml
#22581
Conversation
Co-Authored-By: gabrielwithappy <102908949+gabrielwithappy@users.noreply.github.com>
The documentation is not available anymore as the PR was closed or merged. |
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 🙏💕 |
I think this PR is a good idea to avoid wrong depth mistakes or yaml syntax errors |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks good to me.
I think this PR will help to avoid wrong depth mistakes or yaml syntax errors
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense, thanks!
Co-authored-by: gabrielwithappy <102908949+gabrielwithappy@users.noreply.github.com>
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.yml
file 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:
local
value by copy & pasting directly from the same line number inen/_toctree.yml
.title
value 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.yml
file from theen
folder.ko
,fr
,de
).in_translation.mdx
file 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?