Skip to content

docs(ja): simplify README for readers, keep practical setup and necessary cautions - #119

Merged
sahenjp merged 1 commit into
mainfrom
docs/simplify-japanese-readme-20261106
Nov 6, 2026
Merged

sahenjp merged 1 commit into
mainfrom
docs/simplify-japanese-readme-20261106

Conversation

@sahenjp

@sahenjp sahenjp commented Nov 6, 2026

Copy link
Copy Markdown
Owner

変更内容

  • 日本語READMEをユーザー提案の平易な文体に寄せて書き直し、最初に必要な機能・導入・3プロファイルの違いを分かりやすく整理
  • 接続先の言語設定、トークン計算の内部範囲、ヘルスチェックとメトリクスなど、READMEに書かなくてもよい細部を詳細ドキュメントへ委譲
  • インストール、MCP、Docker、TOMLの実行例、翻訳リンク、リリース自動更新マーカーは維持
  • Fullの規約上の注意とCleanのローカル検索/明示的な本文取得時の外部通信の違いは残す
  • 検索品質は日付と条件の異なる参考値として短く明記し、過大な性能主張を避ける

変更はREADME.ja.mdのみ。実装やベンチマーク記録は変更しません。既存CIで検証します。

@sahenjp
sahenjp merged commit e056b41 into main Nov 6, 2026
14 checks passed
@sahenjp
sahenjp deleted the docs/simplify-japanese-readme-20261106 branch November 6, 2026 12:22
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.

1 participant