Skip to content
This repository was archived by the owner on Jul 9, 2025. It is now read-only.

Commit 3d12d1c

Browse files
authored
Merge pull request #38 from domaframework/remove-crowdin
Remove Crowdin integration and add comprehensive translation guide
2 parents b9ac56c + bf7d060 commit 3d12d1c

File tree

4 files changed

+30
-59
lines changed

4 files changed

+30
-59
lines changed

CLAUDE.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
77
This is the documentation repository for Doma, a database access framework for Java. The documentation is built using Sphinx and hosted on ReadTheDocs. The repository manages:
88

99
- English documentation (primary)
10-
- Japanese translation via Crowdin integration
10+
- Japanese translation
1111
- Multiple output formats (HTML, PDF, ePub)
1212

1313
## Development Commands
@@ -41,12 +41,6 @@ make
4141
cd docs
4242
# Generate POT files for translation
4343
sphinx-build -b gettext . _build/gettext
44-
45-
# Upload to Crowdin (admin only)
46-
crowdin push
47-
48-
# Download translations (admin only)
49-
crowdin pull
5044
```
5145

5246
## Architecture
@@ -74,8 +68,7 @@ These variables can be used in documentation via Jinja templating.
7468

7569
### Translation Workflow
7670
- English content is written in .rst files
77-
- Crowdin integration automatically generates .pot files for translators
78-
- Japanese translations are managed via Crowdin project: https://crowdin.com/project/doma-docs
71+
- POT files for translation are generated using `sphinx-build -b gettext`
7972
- Translated .po files are stored in `/docs/locale/ja/LC_MESSAGES/`
8073

8174
## Content Guidelines

CONTRIBUTING.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -55,21 +55,3 @@ Execute the `sphinx-build` command in the docs directory:
5555
```
5656
$ sphinx-build -b gettext . _build/gettext
5757
```
58-
59-
#### Upload POT files to Crowdin
60-
61-
Execute the `crowdin` command in the docs directory:
62-
63-
```
64-
$ crowdin push
65-
```
66-
67-
This command is only permitted for administrators.
68-
69-
#### Download PO files from Crowdin
70-
71-
Execute the `crowdin` command in the docs directory:
72-
73-
```
74-
$ crowdin pull
75-
```

README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
# Doma Documentation
22

33
This repository manages the English version of the [Doma](https://github.com/domaframework/doma) documentation.
4-
Localization into Japanese is managed through [the Crowdin project](https://crowdin.com/project/doma-docs).
4+
Localization into Japanese is managed manually.
55

66
We welcome contributions to improve both the English and Japanese versions.
77

88
[![docs](https://readthedocs.org/projects/doma/badge/?version=latest)](https://doma.readthedocs.io/en/latest/)
9-
[![Crowdin](https://badges.crowdin.net/doma-docs/localized.svg)](https://crowdin.com/project/doma-docs)
109

1110
## Deployment site
1211

@@ -19,10 +18,35 @@ Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
1918

2019
## To Those Who Can Help with Japanese Translation
2120

22-
日本語翻訳に協力してくれる方は、[Crowdin](https://crowdin.com/project/doma-docs) に登録して翻訳をお願いします
21+
日本語翻訳に協力してくれる方は、[Issues](https://github.com/domaframework/doma-docs/issues) または [Discussions](https://github.com/domaframework/doma-docs/discussions) でお気軽にお声がけください
2322
英語から日本語への翻訳はもちろん、既存の日本語訳の修正や改善も歓迎します。
2423

25-
Crowdinの使い方や翻訳方針に関する質問は [Issues](https://github.com/domaframework/doma-docs/issues) または [Discussions](https://github.com/domaframework/doma-docs/discussions) でお気軽にどうぞ。
24+
### 翻訳の手順
25+
26+
1. **新しい翻訳を追加する場合:**
27+
- `docs` ディレクトリで `sphinx-build -b gettext . _build/gettext` を実行してPOTファイルを生成
28+
- `docs/locale/ja/LC_MESSAGES/` 内の対応する `.po` ファイルを編集
29+
- `msgid` の英語テキストに対応する `msgstr` に日本語翻訳を記入
30+
31+
2. **既存の翻訳を修正する場合:**
32+
- `docs/locale/ja/LC_MESSAGES/` 内の該当する `.po` ファイルを直接編集
33+
- 修正したい `msgstr` の内容を変更
34+
35+
3. **ファイル構成:**
36+
- メインページ: `docs/locale/ja/LC_MESSAGES/index.po`
37+
- 各セクション: `docs/locale/ja/LC_MESSAGES/{セクション名}.po`
38+
- クエリ関連: `docs/locale/ja/LC_MESSAGES/query/{ファイル名}.po`
39+
40+
4. **翻訳例:**
41+
```
42+
msgid "Getting Started"
43+
msgstr "はじめに"
44+
```
45+
46+
5. **AIツールを活用した翻訳:**
47+
- [Claude Code](https://claude.ai/code)[Gemini CLI](https://github.com/google-gemini/gemini-cli) などのコーディングエージェントツールを使って効率的に翻訳できます
48+
- 例: 「このPOファイルの未翻訳部分を日本語に翻訳してください」と依頼
49+
- 大量の翻訳作業や一貫性のチェックに特に有効です
2650

2751
日本語翻訳に関する問い合わせは日本語で登録いただいて構いません。
2852

docs/crowdin.yml

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)