Skip to content

docs: add Chinese language support and improve markdown formatting#326

Closed
hamberluo wants to merge 7 commits intoRetroAchievements:mainfrom
hamberluo:main
Closed

docs: add Chinese language support and improve markdown formatting#326
hamberluo wants to merge 7 commits intoRetroAchievements:mainfrom
hamberluo:main

Conversation

@hamberluo
Copy link

This PR adds comprehensive Chinese (zh) language support to the RetroAchievements documentation and improves markdown formatting consistency across multiple files.

Major Changes:

  1. Chinese Language Support

    • Added complete Chinese translation configuration (docs/.vitepress/config/zh.ts)
    • Translated 120+ documentation files covering:
      • Developer documentation (achievement development, tools, guidelines)
      • General documentation (setup guides, FAQ, how RA works)
      • Guidelines (content, developers, users)
      • Tutorials and team information
    • Updated VitePress configuration to include Chinese language option
  2. Markdown Formatting Improvements

    • Improved formatting consistency in developer documentation files
    • Enhanced readability across multiple documentation pages
    • Standardized markdown structure

Files Modified:

  • Configuration: docs/.vitepress/config/index.ts, shared.ts, new zh.ts
  • 120+ new Chinese documentation files
  • 7 English documentation files with formatting improvements

This contribution significantly expands the accessibility of RetroAchievements documentation for Chinese-speaking users while maintaining consistency with existing documentation standards.

@pinguupinguu
Copy link

Just wanted to add in that this PR was generated via AI, clearly not specified by this user.

Would double check whatever "consistency" this inaccurate AI-generated translation contributes to this PR.

@hamberluo
Copy link
Author

Just wanted to add in that this PR was generated via AI, clearly not specified by this user.

Would double check whatever "consistency" this inaccurate AI-generated translation contributes to this PR.

thank you for your check, i will also check and learn.

…umentation

- Fix untranslated 'unforeseen' in why-delta.md
- Fix English content in VitePress component examples in contributing-to-the-docs.md
- Translate all alert box examples to Chinese (info, tip, warning, danger, details)

Made-with: Cursor
@wescopeland
Copy link
Member

wescopeland commented Mar 8, 2026

I'm a volunteer and can't possibly review a 14,000 line long PR. As a GDE, you should know better.

There is insufficient data to support this change. Our Discord does not have a Mandarin-speaking community. Our website does not support zh_CN. Traffic levels from China, Taiwan, and Hong Kong are very low, with the exception of IP addresses known to be associated with data centers.

Given these facts, I'm unsure how this translation wouldn't drift over time, which would be a disservice to any Mandarin-speaking users who are interested in RA, as they would be getting the wrong information. My perception is those users would be better-served by a current machine translation rather than an outdated one.

@hamberluo
Copy link
Author

I'm a volunteer and can't possibly review a 14,000 line long PR. As a GDE, you should know better.

There is insufficient data to support this change. Our Discord does not have a Mandarin-speaking community. Our website does not support zh_CN. Traffic levels from China, Taiwan, and Hong Kong are very low, with the exception of IP addresses known to be associated with data centers.

Given these facts, I'm unsure how this translation wouldn't drift over time, which would be a disservice to any Mandarin-speaking users who are interested in RA, as they would be getting the wrong information. My perception is those users would be better-served by a current machine translation rather than an outdated one.

Yes, I have checked all the articles.

My mention of MR itself indicates that this was my voluntary effort.

Actually, having AI maintain it is the lowest-cost approach.

Just look at the other two languages;

They are already outdated.

@wescopeland
Copy link
Member

Translations should be driven by user need, not speculative. 120+ translated files will drift the moment any English source doc changes. To your point, this is already happening with other languages.

Any plan to maintain these using AI is unsustainable for us. We're volunteer-run, and my personal belief is outdated translations are worse than none at all because they erode trust.

Furthermore, this PR is unreviewable. I have a responsibility to not merge what I can't verify.

I have no choice but to close this one out. We don't have the capacity to maintain this at the moment, and if this changes in the future, we should start with a smaller-scoped proposal with some sort of plan to keep things sustainable. What I'd really like to see is our docs somehow hooked into Crowdin, but that's a larger-scale project I haven't explored yet.

@wescopeland wescopeland closed this Mar 8, 2026
@hamberluo
Copy link
Author

It depends on who takes the first step—it's a chicken-and-egg problem.

Does having Chinese documentation attract more Chinese contributors?
Or does having Chinese contributors lead to Chinese documentation?

I haven't done large-scale documentation integration with Crowdin before.

However, if a maintainer of Chinese documentation is needed, I'm willing to take on the responsibility, provided the organization accepts me.

@wescopeland
Copy link
Member

I understand what you mean about a potential chicken-and-egg problem. I think the answer for us is actually neither side of the chicken-and-egg.

Browser-based machine translation isn't too far off from what Cursor has output in this PR, and it has zero maintenance cost. Shipping static translations means those translations start drifting the moment any English source doc changes, and then users get a worse experience than they would from enabling Google Translate on the up-to-date English page.

The existing PT and ES translations are a good example of this problem. They're well-intentioned, but already well out of date. Without someone constantly on them, that's how the situation will be ad infinitum. Those languages have significant community presence - they account for roughly 20% of RA's traffic. If anything, I think those translations are something we should reconsider maintaining long-term rather than a precedent we should expand on.

For a volunteer-run project our size, I think leaning on machine translation for these docs is the right call. I appreciate the offer to maintain this, but I have to keep this one closed.

@hamberluo
Copy link
Author

I understand your point about document updates.

In that case, I actually think it might be better to delete other outdated translations.

Perhaps in this scenario, machine translation is more suitable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants