docs: rewrite the documentation and READMEs in English - #552
Open
gapul wants to merge 25 commits into
Open
Conversation
装飾を落として英語に統一した。変えたのは書き方だけで、内容は変えていない。 - 見出しの絵文字 (🟢🟨🟪🟫🟥📖) を削除。情報を足していないのに視線を奪う - 過剰な太字を削除。強調が多すぎると、どれも強調でなくなる - 箇条書きに分解しすぎていた説明を文に戻した 「なぜそうしたか」「何を試して駄目だったか」はそのまま残した。/nix の復号化の 判断や Ghostty の parse 中断の話は、このリポジトリの価値そのものなので削らない。 フックの表は scripts/gen-docs.py が生成しているので、生成元の説明文と表見出しも 英語にした。区切り文字が読点だったのも半角に直した。
歴史記録なので忠実に訳した。ただし #17 (脱 Conduit) は今日 Synapse へ移って 決着したので、結論だけ注記として足した。決着済みの検討を「未決」の顔のまま 残すと、次に読んだ人が同じ検討をやり直す。
gen-docs.py が生成する表ヘッダと CLI メッセージも英語に揃える。
gapul
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs/配下・README・各ディレクトリの README を英語に書き直し、AI が書いたと分かる装飾を落とした。やったこと
README.md+docs/*.md全 13 本configs/windows/mobile/esphome/nix/homelab/templates/配下の README 29 本scripts/gen-docs.pyが生成する表ヘッダと CLI メッセージも英語に統一翻訳しなかったもの（日本語であることが機能なので）
configs/cli/claude/CLAUDE.md— 日本語で応答しろと書いてある設定本体configs/cli/claude/skills/gapul-writing-voice/SKILL.md— 日本語の文体見本そのものが中身configs/cli/claude/skills/step-by-step-tutor/SKILL.md— 日本語の指導プロンプトconfigs/cli/claude/skills/english-vocab/SKILL.md— 日本語のトリガーフレーズと語義例configs/cli/claude/output-styles/english-tutor.md— 日本語で注釈しろという指示残した内容
「なぜそうしたか」「何を試して駄目だったか」は AI らしさではなくこのリポジトリの価値なので、
翻訳しつつ全部残してある。
翻訳ついでに直した事実誤り
HOMESERVER_TODO.mdの digest ピン留め項目と Conduit への言及（Synapse 移行済み）homelab-roadmap.mdの [EPIC] dotfilesの健全性と保守性の向上 #17 の結末（Tuwunel/continuwuity ではなく Synapse を選んだ）mobile/README.mdの Matrix 行の Conduit 表記放置すると読んだ人が決着済みの判断をやり直すことになるため。
確認
python3 scripts/gen-docs.py --checkが通る（生成ブロックと設定が一致）