From 9df9e4a642688b92758067a0d6d4b2773e774efa Mon Sep 17 00:00:00 2001 From: Shunsuke Shibayama Date: Sat, 28 Jan 2023 19:24:34 +0900 Subject: [PATCH] Update dev guide --- doc/EN/dev_guide/README.md | 6 ++++++ doc/EN/dev_guide/SUMMARY.md | 22 ++++++++++++++++++++++ doc/EN/dev_guide/about.md | 4 ++++ doc/EN/dev_guide/i18n_messages.md | 6 +++--- doc/EN/dev_guide/index.md | 21 --------------------- doc/JA/dev_guide/README.md | 8 ++++++++ doc/JA/dev_guide/SUMMARY.md | 22 ++++++++++++++++++++++ doc/JA/dev_guide/about.md | 4 ++++ doc/JA/dev_guide/i18n_messages.md | 2 +- doc/JA/dev_guide/index.md | 23 ----------------------- doc/zh_CN/dev_guide/i18n_messages.md | 4 ++-- doc/zh_TW/dev_guide/i18n_messages.md | 4 ++-- 12 files changed, 74 insertions(+), 52 deletions(-) create mode 100644 doc/EN/dev_guide/README.md create mode 100644 doc/EN/dev_guide/SUMMARY.md create mode 100644 doc/EN/dev_guide/about.md delete mode 100644 doc/EN/dev_guide/index.md create mode 100644 doc/JA/dev_guide/README.md create mode 100644 doc/JA/dev_guide/SUMMARY.md create mode 100644 doc/JA/dev_guide/about.md delete mode 100644 doc/JA/dev_guide/index.md diff --git a/doc/EN/dev_guide/README.md b/doc/EN/dev_guide/README.md new file mode 100644 index 000000000..85fd2f037 --- /dev/null +++ b/doc/EN/dev_guide/README.md @@ -0,0 +1,6 @@ +# Erg development guide + +This document is a guide to developing the Erg project. +It describes the internal structure of the erg compiler, how to make contributions, guidelines for development, and how to set up the development environment, etc. + +You can read the HTML version at [here](https://erg-lang.org/dev-guide/JA). diff --git a/doc/EN/dev_guide/SUMMARY.md b/doc/EN/dev_guide/SUMMARY.md new file mode 100644 index 000000000..533d41a4a --- /dev/null +++ b/doc/EN/dev_guide/SUMMARY.md @@ -0,0 +1,22 @@ +# Summary + + + +[about this guide](./about.md) + +--- + +- [branch policy](branches.md) +- [build features](build_features.md) +- [directory structure](directories.md) +- [document guideline](doc_guideline.md) +- [embedding](embedding.md) +- [development environment](env.md) +- [internationalization](i18n_messages.md) +- [Rust code guideline](rust_code_guideline.md) +- [test](test.md) +- [troubleshooting](troubleshooting.md) +- [versioning](version.md) diff --git a/doc/EN/dev_guide/about.md b/doc/EN/dev_guide/about.md new file mode 100644 index 000000000..c8b4867d4 --- /dev/null +++ b/doc/EN/dev_guide/about.md @@ -0,0 +1,4 @@ +# About this guide + +This document is a guide to developing the Erg project. +It describes the internal structure of the erg compiler, how to make contributions, guidelines for development, and how to set up the development environment, etc. diff --git a/doc/EN/dev_guide/i18n_messages.md b/doc/EN/dev_guide/i18n_messages.md index 605913ad1..c87d638e9 100644 --- a/doc/EN/dev_guide/i18n_messages.md +++ b/doc/EN/dev_guide/i18n_messages.md @@ -38,9 +38,9 @@ The `{name}` part is Rust's formatting feature that allows you to embed the cont Now let's build with the `--features simplified_chinese` option. -screenshot_i18n_messages +screenshot_i18n_messages -You did it, did not you! +You did it! ## FAQs @@ -55,4 +55,4 @@ A: We currently support the following languages: * "simplified_chinese" (Simplified Chinese) * "traditional_chinese" (Traditional Chinese) -If you would like to add languages ​​other than these, please make a request. \ No newline at end of file +If you would like to add languages ​​other than these, please make a request. diff --git a/doc/EN/dev_guide/index.md b/doc/EN/dev_guide/index.md deleted file mode 100644 index 33128999d..000000000 --- a/doc/EN/dev_guide/index.md +++ /dev/null @@ -1,21 +0,0 @@ -# Index - -## [branches](branches.md) - -## [build_features](build_features.md) - -## [directories](directories.md) - -## [doc_guideline](doc_guideline.md) - -## [env](env.md) - -## [embedding](embedding.md) - -## [i18n_messages](i18n_messages.md) - -## [rust_code_guideline](rust_code_guideline.md) - -## [test](test.md) - -## [troubleshooting](troubleshooting.md) diff --git a/doc/JA/dev_guide/README.md b/doc/JA/dev_guide/README.md new file mode 100644 index 000000000..7274fdcb7 --- /dev/null +++ b/doc/JA/dev_guide/README.md @@ -0,0 +1,8 @@ +# Erg開発ガイド + +[![badge](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fgezf7g7pd5.execute-api.ap-northeast-1.amazonaws.com%2Fdefault%2Fsource_up_to_date%3Fowner%3Derg-lang%26repos%3Derg%26ref%3Dmain%26path%3Ddoc/EN/dev_guide/README.md%26commit_hash%3D64fec7d91494cbb22f89147863db2a8ee81954db)](https://gezf7g7pd5.execute-api.ap-northeast-1.amazonaws.com/default/source_up_to_date?owner=erg-lang&repos=erg&ref=main&path=doc/EN/dev_guide/README.md&commit_hash=64fec7d91494cbb22f89147863db2a8ee81954db) + +本ドキュメントはErgプロジェクトの開発に関するガイドです。 +ergコンパイラの内部構造や、コントリビューションの方法、開発に関する指針、開発環境のセットアップ方法などを説明しています。 + +[こちら](https://erg-lang.org/dev-guide/JA)からHTML版を読むことができます。 diff --git a/doc/JA/dev_guide/SUMMARY.md b/doc/JA/dev_guide/SUMMARY.md new file mode 100644 index 000000000..082e33d01 --- /dev/null +++ b/doc/JA/dev_guide/SUMMARY.md @@ -0,0 +1,22 @@ +# 概要 + + + +[このガイドについて](./about.md) + +--- + +- [ブランチ運用方針](branches.md) +- [build features](build_features.md) +- [ディレクトリ構造](directories.md) +- [ドキュメントのガイドライン](doc_guideline.md) +- [組み込み](embedding.md) +- [開発環境](env.md) +- [多言語化](i18n_messages.md) +- [Rustコードガイドライン](rust_code_guideline.md) +- [テスト](test.md) +- [トラブルシューティング](troubleshooting.md) +- [バージョニング](version.md) diff --git a/doc/JA/dev_guide/about.md b/doc/JA/dev_guide/about.md new file mode 100644 index 000000000..8c990ce16 --- /dev/null +++ b/doc/JA/dev_guide/about.md @@ -0,0 +1,4 @@ +# このガイドについて + +本ドキュメントはErgプロジェクトの開発に関するガイドです。 +ergコンパイラの内部構造や、コントリビューションの方法、開発に関する指針、開発環境のセットアップ方法などを説明しています。 diff --git a/doc/JA/dev_guide/i18n_messages.md b/doc/JA/dev_guide/i18n_messages.md index d5170f1a1..8bdb51ff8 100644 --- a/doc/JA/dev_guide/i18n_messages.md +++ b/doc/JA/dev_guide/i18n_messages.md @@ -40,7 +40,7 @@ switch_lang!( では、`--features simplified_chinese` オプションを付けてビルドしてみましょう。 -screenshot_i18n_messages +screenshot_i18n_messages やりましたね! diff --git a/doc/JA/dev_guide/index.md b/doc/JA/dev_guide/index.md deleted file mode 100644 index 0c85731c0..000000000 --- a/doc/JA/dev_guide/index.md +++ /dev/null @@ -1,23 +0,0 @@ -# Index - -[![badge](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fgezf7g7pd5.execute-api.ap-northeast-1.amazonaws.com%2Fdefault%2Fsource_up_to_date%3Fowner%3Derg-lang%26repos%3Derg%26ref%3Dmain%26path%3Ddoc/EN/dev_guide/index.md%26commit_hash%3D64fec7d91494cbb22f89147863db2a8ee81954db)](https://gezf7g7pd5.execute-api.ap-northeast-1.amazonaws.com/default/source_up_to_date?owner=erg-lang&repos=erg&ref=main&path=doc/EN/dev_guide/index.md&commit_hash=64fec7d91494cbb22f89147863db2a8ee81954db) - -## [ブランチ](./branches.md) - -## [build_features](./build_features.md) - -## [ディレクトリ構造](./directories.md) - -## [ドキュメントガイドライン](./doc_guideline.md) - -## [開発環境](./env.md) - -## [組み込み](./embedding.md) - -## [メッセージの多言語化](./i18n_messages.md) - -## [Rustコードガイドライン](./rust_code_guideline.md) - -## [テスト](./test.md) - -## [トラブルシューティング](./troubleshooting.md) diff --git a/doc/zh_CN/dev_guide/i18n_messages.md b/doc/zh_CN/dev_guide/i18n_messages.md index 86d02dd5d..f2a6438d3 100644 --- a/doc/zh_CN/dev_guide/i18n_messages.md +++ b/doc/zh_CN/dev_guide/i18n_messages.md @@ -39,7 +39,7 @@ switch_lang!( 现在，我们使用选项构建它 -screenshot_i18n_messages +screenshot_i18n_messages 你做到了！ @@ -54,4 +54,4 @@ Q: 如果想添加自己的语言，该如何替换部分?答: 目前支持以 * "simplified_chinese" (简体中文) * "traditional_chinese" (繁体中文) -如果你想添加其他语言，请提出请求。 \ No newline at end of file +如果你想添加其他语言，请提出请求。 diff --git a/doc/zh_TW/dev_guide/i18n_messages.md b/doc/zh_TW/dev_guide/i18n_messages.md index ddd09c4d6..d32387d2b 100644 --- a/doc/zh_TW/dev_guide/i18n_messages.md +++ b/doc/zh_TW/dev_guide/i18n_messages.md @@ -39,7 +39,7 @@ switch_lang!( 現在，我們使用選項構建它 -screenshot_i18n_messages +screenshot_i18n_messages 你做到了！ @@ -54,4 +54,4 @@ Q: 如果想添加自己的語言，該如何替換部分?答: 目前支持以 * "simplified_chinese" (簡體中文) * "traditional_chinese" (繁體中文) -如果你想添加其他語言，請提出請求。 \ No newline at end of file +如果你想添加其他語言，請提出請求。