Skip to content

Add a Traditional Chinese reading guide - #40

Merged
JusperLee merged 3 commits into
JusperLee:mainfrom
Djshinshin:codex/zh-tw-wording
Aug 14, 2026
Merged

Add a Traditional Chinese reading guide#40
JusperLee merged 3 commits into
JusperLee:mainfrom
Djshinshin:codex/zh-tw-wording

Conversation

@Djshinshin

@Djshinshin Djshinshin commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Motivation

To make Apollo a little easier to approach for readers in Taiwan and other Traditional Chinese readers, and hopefully help more people discover this open-source project, this PR adds a small optional reading guide. The English README remains the canonical source for complete and current technical information.

I appreciate the maintainers' guidance on keeping the change focused. If this additional guide does not fit the project's current documentation plans, I would be happy to revise or withdraw it.

Summary

  • Add README.zh-TW.md as a concise Traditional Chinese reading guide rather than a full localization.
  • Keep section headings and technical terminology in English where that improves consistency with the code, paper, and upstream documentation.
  • Add an English Traditional Chinese guide navigation link to README.md.
  • Keep all source code and existing code comments unchanged from upstream/main.
  • State clearly that the English README and paper remain authoritative.

Validation

  • python -m py_compile inference.py tests/test_inference.py look2hear/utils/parser_utils.py look2hear/utils/pylogger.py train.py
  • python -m unittest discover -s tests -v: 14/14 passed
  • python -m pip check: no broken requirements
  • git diff --check
  • Final diff against upstream/main: two Markdown files only

This PR does not modify inference or training behavior, checkpoints, audio fixtures, generated artifacts, or any private audio.

@JusperLee

Copy link
Copy Markdown
Owner

Thank you for supporting Traditional Chinese. My suggestion is to avoid adding Chinese code and instead announce the change in English.

@JusperLee
JusperLee requested a balanced review from Copilot August 14, 2026 06:47

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@Djshinshin Djshinshin changed the title Add Traditional Chinese documentation Add a Traditional Chinese reading guide Aug 14, 2026
@Djshinshin

Copy link
Copy Markdown
Contributor Author

Thank you for the guidance. I identified the scope issue and have now corrected it. The latest update removes the Chinese changes from source-code comments and restores the code exactly to upstream/main.

I also shortened README.zh-TW.md into a lightweight optional reading guide rather than a full localization. Technical headings and terminology remain in English where appropriate, the announcement in README.md is in English, and the English README remains canonical. The final PR diff now contains only two Markdown files, and the local checks pass, including 14/14 unit tests.

I also recognize that I published the earlier iteration too quickly. Going forward, I will complete and review the full change locally before pushing an update or replying. Thank you again for your patience and guidance.

@JusperLee
JusperLee marked this pull request as ready for review August 14, 2026 06:56
@JusperLee

Copy link
Copy Markdown
Owner

Thanks for addressing the scope issue and updating the PR.

I reviewed the latest changes, and everything looks good now. The PR is appropriately limited to the two Markdown files, the source code matches upstream/main, and all validation checks pass.

The English announcement and the positioning of the Traditional Chinese guide as optional, with the English README remaining canonical, are clear.

LGTM. Approved from my side. Thanks for the careful follow-up!

@JusperLee
JusperLee merged commit 4f3ff07 into JusperLee:main Aug 14, 2026
1 check passed
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