Skip to content

refactor: Webサイトの生成スクリプトのdocs/i18n/の入出力処理を削除 #72

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

Merged
merged 3 commits into from
Nov 19, 2024

Conversation

3w36zj6
Copy link
Member

@3w36zj6 3w36zj6 commented Nov 10, 2024

close #66

変更点

  • docs/i18n/を削除した
  • Webサイトの生成スクリプトのYAMLの入出力処理を削除してリファクタリングした

確認事項

  • python gen.pyで以前と同様にWebサイトを生成できる

備考

@3w36zj6 3w36zj6 changed the title chore: docs/i18n/を削除 refactor: Webサイトの生成スクリプトのdocs/i18n/の入出力処理を削除 Nov 10, 2024
@3w36zj6 3w36zj6 marked this pull request as ready for review November 10, 2024 06:27
@3w36zj6 3w36zj6 marked this pull request as draft November 16, 2024 13:54
@3w36zj6 3w36zj6 force-pushed the feature/refactor-docs-generator branch from 3ee0e31 to a16a6de Compare November 17, 2024 14:14
@3w36zj6 3w36zj6 marked this pull request as ready for review November 17, 2024 14:20
Copy link
Contributor

@mkpoli mkpoli left a comment

Choose a reason for hiding this comment

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

ウェブサイト自体は今のところ特に問題なく動いているようです。

また、コメントを変更し、再generateすることによって、正しくリファレンスが変わることを確認することができました。

image

image

どうもありがとうございます。

Copy link
Contributor

@kimushun1101 kimushun1101 left a comment

Choose a reason for hiding this comment

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

私の方でも書き換えも含めて動作確認できました。素晴らしい改修ありがとうございました。

本件に関してCONTRIBUTING.mdも書き直した方がよいと思いますがいかがでしょう?別プルリクエストで実施しますか?

2. ドキュメントの実体は、主にMarkdownおよびYAMLの2種類のファイルから構成されています。それぞれ、下記の注意書きに従って翻訳作業をお願いします。
1. `./docs/i18n/**/`内のYAMLファイル群は、Typstの言語リファレンスの本体です。その中に含まれている、**既存の`*-ja.yaml`ファイルを直接書き換えて翻訳してください****`*-en.yaml``*-zh.yaml`は翻訳しないでください**
- 例:[Reference > Model](https://typst.app/docs/reference/model/)を翻訳する際は、`./docs/i18n/category/model-ja.yaml`を編集してください。`model-en.yaml``model-zh.yaml`は放置してください。

説明としては「./crates/typst/src/以下のファイルの///から始まるコメントアウト部分を和訳してください。」みたいな感じでしょうか?これはRustのドキュメンテーションコメントと連動しており、//から始まるコメントアウトはドキュメントと関係ないと思うのですが、ドキュメンテーションコメントでもWebページ上に現れるものと現れないものがあって仕組みがよくわかっていないです。

@3w36zj6
Copy link
Member Author

3w36zj6 commented Nov 19, 2024

確かにこのPRの責務にCONTRIBUTING.mdの書き換えを含めるのは妥当だと思いますが、今回はソースコード内のどのコメントがドキュメントに反映されるかなど翻訳の手順に未知な点があるため、実際に翻訳作業を行った上での知見を貢献ガイドに反映できると良いと思います。そこで、貢献ガイドの更新と翻訳を平行して進められるように、別のPRで扱うのが良いかと思いますがいかがでしょうか?

@kimushun1101
Copy link
Contributor

ご検討いただきありがとうございます。別PRでの実施で問題ないと思います。気づいているかとすぐに対応できそうかを確認したかったという意図でうががいました。

  • 私としても Translate reference visualize image #70 で(おそらくこれはクローズして新規PRを立ち上げると思いますが)手を動かしながら検証できるため、現時点でもマージされる方が嬉しいです。

@3w36zj6 3w36zj6 merged commit c728d75 into typst-jp:main Nov 19, 2024
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.

docs/i18n/でのドキュメントの管理をやめる
3 participants