docs: README を英語版にし、日本語版を README.ja.md として残す - #132
Merged
Conversation
npm / GitHub の顔になる README.md を英語にして、日本語の内容は README.ja.md へ退避した(`git mv` なので履歴は追える)。 - README.md: 全節を英訳。冒頭に日本語版への案内を置く - README.ja.md: 冒頭に英語版への案内、開発節に「日本語が原本・英語は対で更新」を明記 - .claude/rules/workflow.md / add-config-option / add-slash-command: ユーザー可視の変更では README を 2 ファイル対で更新するようチェックリストを修正
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
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.
概要
npm / GitHub の顔になる
README.mdを英語にし、これまでの日本語の内容はREADME.ja.mdとして残しました。両方の冒頭でお互いを案内しています。git mv README.md README.ja.md→ 新規に英語版README.mdを作成(履歴は追えます)/sync・/fix-ci/ プラン・使用状況 //agentとエージェント差 / 設定全キー / トラブルシューティング / 開発 / リリース)README.md冒頭:**日本語のドキュメントは [README.ja.md](./README.ja.md) にあります。**README.ja.md冒頭:**このページは日本語版です。English documentation is available in [README.md](./README.md).**ドキュメント運用
日本語(
README.ja.md)を原本、英語(README.md)をその訳として扱い、ユーザー可視の変更では2 ファイル対で更新する方針を明記しました。README.ja.mdの「開発」節に原本・訳の関係を注記.claude/rules/workflow.mdのドキュメント役割分担の表と「変更時に一緒に更新するもの」チェックリスト.claude/skills/add-config-option/SKILL.md(設定表)と.claude/skills/add-slash-command/SKILL.md(コマンド説明)のチェックリストdocs/と.claude/は現状日本語のみで、これは README にも注記してあります。補足
package.jsonのfilesは["dist"]のままです(npm はREADME.mdを常に同梱するので、npm ページは英語になります。README.ja.mdは GitHub 側のリンクで辿ります)。#choosing-and-switching-agents-agent/#changing-settings-from-the-ui-config)。テスト