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

Add English documentations. #1496

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

WeepingDogel
Copy link

Description

Added English translations for project documentation to improve accessibility for English-speaking users. The translations include:

  • Added language switcher links between English and Japanese versions
  • Translated README.md to README.en.md
  • Translated CONTRIBUTING.md to CONTRIBUTING.en.md
  • Translated documentation in docs/ directory:
    • Integration with VOICEVOX Speech Synthesis Engine
    • Resource File URLs and Filemap
    • Glossary

The translations maintain technical accuracy while providing natural English explanations.

Additional Notes

All translations have been carefully reviewed to ensure they accurately convey the technical content while being accessible to English-speaking users. The original Japanese files remain unchanged, and language switcher links have been added to help users navigate between versions.

@WeepingDogel WeepingDogel requested a review from a team as a code owner December 2, 2024 02:44
@WeepingDogel WeepingDogel requested review from Hiroshiba and removed request for a team December 2, 2024 02:44
CONTRIBUTING.en.md Outdated Show resolved Hide resolved
Comment on lines +416 to +417
This is a dual license of LGPL v3 and another license that does not require source code disclosure.
If you want to obtain the other license, please contact Hiho.
Copy link

@cm-ayf cm-ayf Dec 2, 2024

Choose a reason for hiding this comment

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

@Hiroshiba
日本語は以下のようになっています:

LGPL v3 と、ソースコードの公開が不要な別ライセンスのデュアルライセンスです。 別ライセンスを取得したい場合は、ヒホに求めてください。

2文目で「別ライセンス」と言っているものは,LGPL v3 と並列して用意されている「ソースコードの公開が不要な別ライセンス」のことであるという認識ですが,問題ないでしょうか.ここに提示されている英訳はこの認識に符合するものです.

日本語に曖昧さがあるように感じているため,確認しています.


This comment is confirming that the translation has strictly the same meaning as the original; the original has a little ambiguous expression.

Copy link
Member

Choose a reason for hiding this comment

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

需要がわからないので幅広い需要に答えられる文章にしています! とりあえずこの段階では曖昧方向に倒したいです 🙇
(「ソースコードの公開が不要」以外のライセンスも考えられるので)

「別ライセンスを取得したい場合は、ヒホに求めてください。」のニュアンスを少し正確にすると、「(LGPL以外の)別ライセンスを取得したい場合は」になりそうです 🙇

docs/Glossary.en.md Outdated Show resolved Hide resolved
docs/Glossary.en.md Outdated Show resolved Hide resolved
docs/Glossary.en.md Outdated Show resolved Hide resolved
docs/Glossary.en.md Outdated Show resolved Hide resolved
docs/Glossary.en.md Outdated Show resolved Hide resolved
@Hiroshiba
Copy link
Member

Thank you for the pull request!
@cm-ayf Thanks for the review as well!

Since VOICEVOX Song is a singing synthesis software and songs generally transcend language barriers, we see some value in translating the documentation into English in anticipation of demand.

However, increasing maintenance costs is a concern, so we'd like to carefully consider how to maintain maintainability while providing information as accurately as possible.

  • When adding to the Japanese documentation, we'd like to make it optional to add to the English documentation.
    • The intention is to avoid slowing down the development pace.
    • Since there's a possibility that the English documentation may become outdated, we'd like to include somewhere a note saying, "For the latest version, please refer to the Japanese documentation," with a link.
  • To make maintenance easier and understand the correspondence, we'd like to align the file names with the Japanese ones.
    • For example, how about naming the English file of 用語集.md as 用語集.en.md?
    • It might seem a bit odd, but considering maintainability, I think this format would be good for now...
    • Maybe we could use a simple English word for the file name.
  • Before releasing the English README, we'd like to have the Terms of Service translated into English.
    • I plan to prepare an English version of the Terms of Service on the official VOICEVOX website.
    • This might take quite some time. I'm very sorry, but please wait.

日本語

プルリクエストありがとうございます!
@cm-ayf さんもレビューありがとうございます!

VOICEVOX Songは歌唱合成であり、歌は一般的に言語の壁を超えるので、需要を見越してドキュメントの英語翻訳にはある程度価値を感じています。
ただ特にメンテナンスのコストの増加が課題になるので、メンテナンス性が保たれつつ、かつ情報がなるべく正確に提供できるよう色々考えたいです。

  • 日本語のドキュメントを書き足す時、英語のドキュメントを書きたすかは任意にしたい
    • 開発のスピード感を緩めたくないという意図です
    • 英語のドキュメントが古くなる可能性があるため、どこかに「最新版は日本語のものを参照してください」と書いてリンクしておきたいです
  • 対応関係がわからずメンテナンスしづらいので、ファイル名は日本語のものと揃えたい
    • 例えば用語集.mdの英語ファイルは用語集.en.mdにするのはどうでしょうか
    • なんか変かもしれませんが、メンテナンス性考えるといったんこの形が良いかなと・・・。
    • ファイル名を簡単な英単語にしても良いかも
  • 英語READMEのリリースの前に、利用規約の英語翻訳をしておきたい
    • 僕がVOICEVOX公式ページの方で利用規約の英語版を用意しようと思います
    • こちらはかなり時間がかかるかもしれません

@WeepingDogel
Copy link
Author

Thank you for the pull request!
@cm-ayf Thanks for the review as well!

Since VOICEVOX Song is a singing synthesis software and songs generally transcend language barriers, we see some value in translating the documentation into English in anticipation of demand.

However, increasing maintenance costs is a concern, so we'd like to carefully consider how to maintain maintainability while providing information as accurately as possible.

  • When adding to the Japanese documentation, we'd like to make it optional to add to the English documentation.
    • The intention is to avoid slowing down the development pace.
    • Since there's a possibility that the English documentation may become outdated, we'd like to include somewhere a note saying, "For the latest version, please refer to the Japanese documentation," with a link.
  • To make maintenance easier and understand the correspondence, we'd like to align the file names with the Japanese ones.
    • For example, how about naming the English file of 用語集.md as 用語集.en.md?
    • It might seem a bit odd, but considering maintainability, I think this format would be good for now...
    • Maybe we could use a simple English word for the file name.
  • Before releasing the English README, we'd like to have the Terms of Service translated into English.
    • I plan to prepare an English version of the Terms of Service on the official VOICEVOX website.
    • This might take quite some time. I'm very sorry, but please wait.

日本語

プルリクエストありがとうございます!
@cm-ayf さんもレビューありがとうございます!

VOICEVOX Songは歌唱合成であり、歌は一般的に言語の壁を超えるので、需要を見越してドキュメントの英語翻訳にはある程度価値を感じています。
ただ特にメンテナンスのコストの増加が課題になるので、メンテナンス性が保たれつつ、かつ情報がなるべく正確に提供できるよう色々考えたいです。

  • 日本語のドキュメントを書き足す時、英語のドキュメントを書きたすかは任意にしたい
    • 開発のスピード感を緩めたくないという意図です
    • 英語のドキュメントが古くなる可能性があるため、どこかに「最新版は日本語のものを参照してください」と書いてリンクしておきたいです
  • 対応関係がわからずメンテナンスしづらいので、ファイル名は日本語のものと揃えたい
    • 例えば用語集.mdの英語ファイルは用語集.en.mdにするのはどうでしょうか
    • なんか変かもしれませんが、メンテナンス性考えるといったんこの形が良いかなと・・・。
    • ファイル名を簡単な英単語にしても良いかも
  • 英語READMEのリリースの前に、利用規約の英語翻訳をしておきたい
    • 僕がVOICEVOX公式ページの方で利用規約の英語版を用意しようと思います
    • こちらはかなり時間がかかるかもしれません

Ok, it's up to you ~

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