Skip to content
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

i18n(zh-cn): Update sidebar.mdx #1761

Merged
merged 8 commits into from
Apr 18, 2024
Merged

Conversation

huyikai
Copy link
Contributor

@huyikai huyikai commented Apr 16, 2024

Description

Update sidebar.mdx

Upstream #1751

Copy link

changeset-bot bot commented Apr 16, 2024

⚠️ No Changeset found

Latest commit: 77fa15f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Apr 16, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
starlight ✅ Ready (Inspect) Visit Preview Apr 18, 2024 0:06am

@github-actions github-actions bot added i18n Anything to do with internationalization & translation efforts 📚 docs Documentation website changes labels Apr 16, 2024
Co-authored-by: liruifengv <liruifeng1024@gmail.com>
Copy link
Member

@liruifengv liruifengv left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks!

@HiDeoo
Copy link
Member

HiDeoo commented Apr 16, 2024

Thanks for the update and the review.

Small question: I see that labels like "constellations", "moons", "stars", etc. are not translated and same for constellation names like "Andromeda". Is this on purpose? Do you think it's better to leave them in English? Is this a domain-specific where English is more common? Could something like "Andromeda" be translated to "仙女座" or this would not make sense?

Of course, this is just a question, you definitely know better than me what is best in this case and I'd like your opinions.

@huyikai
Copy link
Contributor Author

huyikai commented Apr 16, 2024

Thanks for the update and the review.

Small question: I see that labels like "constellations", "moons", "stars", etc. are not translated and same for constellation names like "Andromeda". Is this on purpose? Do you think it's better to leave them in English? Is this a domain-specific where English is more common? Could something like "Andromeda" be translated to "仙女座" or this would not make sense?

Of course, this is just a question, you definitely know better than me what is best in this case and I'd like your opinions.

Hi HiDeoo, nice to communicate with you.

I didn't translate these contents for the following reasons.

  1. Some of the content involves paths and filenames, which are usually not set in Chinese due to issues such as sorting. Translating them into Chinese would be somewhat counterintuitive.

  2. In my opinion, in an English-speaking environment, these terms in the documentation have a kind of easter egg feel for Starlight. However, as far as I know, the educational foundation in Chinese-speaking environments rarely includes a knowledge system about astronomy or constellations. People are not sensitive to these terms in Chinese, and translating them might actually make it harder to understand.

  3. The most important point is to differentiate from the i18n content below, so that readers can better understand the use of basics and the use of internationalization.

@liruifengv
Copy link
Member

Thanks for the update and the review.

Small question: I see that labels like "constellations", "moons", "stars", etc. are not translated and same for constellation names like "Andromeda". Is this on purpose? Do you think it's better to leave them in English? Is this a domain-specific where English is more common? Could something like "Andromeda" be translated to "仙女座" or this would not make sense?

Of course, this is just a question, you definitely know better than me what is best in this case and I'd like your opinions.

Nope. This is not English domain-specific. I think it would be fun to translate them too.
For Default sidebar, I'm not sure whether if need translate, because we don't usually use Chinese for file paths. Maybe we should keep them in English?

@HiDeoo
Copy link
Member

HiDeoo commented Apr 16, 2024

Thanks you both for your feedback, really appreciated.

Thanks for the update and the review.
Small question: I see that labels like "constellations", "moons", "stars", etc. are not translated and same for constellation names like "Andromeda". Is this on purpose? Do you think it's better to leave them in English? Is this a domain-specific where English is more common? Could something like "Andromeda" be translated to "仙女座" or this would not make sense?
Of course, this is just a question, you definitely know better than me what is best in this case and I'd like your opinions.

Nope. This is not English domain-specific. I think it would be fun to translate them too. For Default sidebar, I'm not sure whether if need translate, because we don't usually use Chinese for file paths. Maybe we should keep them in English?

Indeed, and I guess having /constellations/something but the label being translated is not as obvious as having /constellations/something and the label being "Constellations" as pointed out by @huyikai.

The most important point is to differentiate from the i18n content below, so that readers can better understand the use of basics and the use of internationalization.

What is done in the French translation for example, is that default labels are translated in French but we keep the original translations in pt-BR so readers can still see the internationalization in action. Altho, again, it's easier as having file paths in French is not an issue and fairly common.


Considering all this, maybe only "Resources" in this section should be translated as this is a safe one, right?

@HiDeoo
Copy link
Member

HiDeoo commented Apr 16, 2024

Tiny update if this can help the discussion: we had the same discussion for the ko-KR PR where the final result is mostly translated except some very specific terms ("New", "Outdated", "Stub") which did not make sense. Maybe it could help figuring out what is best in this case.

@huyikai
Copy link
Contributor Author

huyikai commented Apr 17, 2024

Tiny update if this can help the discussion: we had the same discussion for the ko-KR PR where the final result is mostly translated except some very specific terms ("New", "Outdated", "Stub") which did not make sense. Maybe it could help figuring out what is best in this case.

Well, I looked at the final result of the ko-KR, and I think it is reasonable, so I added the Chinese translation with reference to the ko-KR.

Copy link
Member

@HiDeoo HiDeoo left a comment

Choose a reason for hiding this comment

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

Thanks for the update, this is looking really great 👍

I left a few suggestions for the case of nested folders in autogenerated groups which would use the folder name (this would also becomes more obvious for readers with the translated content that we do not support this yet as nested folders would be using the folder name in English).

Except for that, everything looks in order to me.

docs/src/content/docs/zh-cn/guides/sidebar.mdx Outdated Show resolved Hide resolved
docs/src/content/docs/zh-cn/guides/sidebar.mdx Outdated Show resolved Hide resolved
docs/src/content/docs/zh-cn/guides/sidebar.mdx Outdated Show resolved Hide resolved
huyikai and others added 3 commits April 18, 2024 07:55
Co-authored-by: HiDeoo <494699+HiDeoo@users.noreply.github.com>
Co-authored-by: HiDeoo <494699+HiDeoo@users.noreply.github.com>
Co-authored-by: HiDeoo <494699+HiDeoo@users.noreply.github.com>
@huyikai
Copy link
Contributor Author

huyikai commented Apr 18, 2024

Thanks for the update, this is looking really great 👍

I left a few suggestions for the case of nested folders in autogenerated groups which would use the folder name (this would also becomes more obvious for readers with the translated content that we do not support this yet as nested folders would be using the folder name in English).

Except for that, everything looks in order to me.

Thanks for your correction. I submitted your suggestions. Could you please confirm again.

Copy link
Member

@HiDeoo HiDeoo left a comment

Choose a reason for hiding this comment

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

Amazing, this is looking really great. Thanks a lot for the updates 🙌

@HiDeoo HiDeoo merged commit 4162424 into withastro:main Apr 18, 2024
9 checks passed
HiDeoo added a commit to HiDeoo/starlight that referenced this pull request Apr 22, 2024
* main: (32 commits)
  i18n(pt-br): Update `getting-started.mdx` (withastro#1776)
  i18n(es): update `configuration` (withastro#1766)
  [ci] format
  Add TrueCharts to showcases (withastro#1773)
  i18n(zh-cn): Update `sidebar.mdx` (withastro#1761)
  i18n(ko-KR): update `sidebar.mdx` (withastro#1760)
  i18n(fr): update `guides/sidebar` (withastro#1758)
  test: fix Windows path separator test issues (withastro#1759)
  i18n(fr): Update `reference/configuration.mdx` from withastro#1729 (withastro#1757)
  docs: rewrite `guides/sidebar` examples to be more generic (withastro#1751)
  i18n(ja): Update community-content.mdx (withastro#1756)
  i18n(ja): Update configuration.mdx (withastro#1755)
  i18n(zh-cn): Update `configuration.mdx` (withastro#1753)
  i18n(ko-KR): update `configuration.mdx` (withastro#1752)
  docs: add caution about scripts processing when using head config (withastro#1729)
  i18n(es): update `community-content` (withastro#1740)
  i18n(pt-br): Update `resources/community-content.mdx` (withastro#1747)
  format: quick fix
  [ci] format
  [ci] format
  ...
HiDeoo added a commit to HiDeoo/starlight that referenced this pull request Apr 30, 2024
* main: (21 commits)
  Update fa.json (withastro#1793)
  i18n(fr): update `resources/community-content.mdx` (withastro#1795)
  [ci] format
  i18n(ko-KR): update `community-content.mdx` (withastro#1794)
  [ci] format
  Adds Starlight in Next.js project video (withastro#1789)
  [ci] format
  i18n(ru): update translations (withastro#1783)
  i18n(id): Update getting-started.mdx (withastro#1778)
  Upgrade Lunaria and add Action (withastro#1768)
  [ci] format
  i18n(es): update `sidebar` (withastro#1767)
  i18n(pt-br): Update `getting-started.mdx` (withastro#1776)
  i18n(es): update `configuration` (withastro#1766)
  [ci] format
  Add TrueCharts to showcases (withastro#1773)
  i18n(zh-cn): Update `sidebar.mdx` (withastro#1761)
  i18n(ko-KR): update `sidebar.mdx` (withastro#1760)
  i18n(fr): update `guides/sidebar` (withastro#1758)
  test: fix Windows path separator test issues (withastro#1759)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 docs Documentation website changes i18n Anything to do with internationalization & translation efforts
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants