Feature/add explanation to env

[tegnike]

Summary by CodeRabbit

• 新機能

  • 新しいAIサービス用の環境変数を追加し、フロントエンドでの使用をサポート。
  • メッセージ受信機能を強化し、リアルタイムAPIとの統合を実現。
  • 新しいAPIエンドポイントを追加し、音声合成機能を向上。

• バグ修正

  • ドキュメントの明確化と新しい言語サポートの手順を追加。

• ドキュメント

  • 新しい寄付者を追加し、貢献者向けのガイドラインを更新。

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
aituber-kit	🔄 Building (Inspect)	Visit Preview	💬 Add feedback	Oct 14, 2024 7:41am

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

このプルリクエストでは、環境変数の追加とドキュメントの更新、ローカリゼーションファイルの拡充、APIハンドラーの改良が行われました。.envおよび.env.exampleファイルに新しいAIサービス用の環境変数が追加され、READMEファイルには新しい言語サポートの手順が記載されています。さらに、音声合成機能に関連する複数のファイルが削除され、リアルタイムAPIの処理を強化するための新しいコンポーネントや関数が追加されました。

Changes

ファイルパス	変更概要
.env, .env.example	新しい環境変数の追加、既存のコメントの修正。
README.md, docs/README_en.md, docs/README_ko.md, docs/README_zh.md	新しい寄付者の追加、言語追加手順の詳細化、ボイス言語コード追加手順の明確化。
locales/en/translation.json, locales/ja/translation.json, locales/ko/translation.json, locales/zh/translation.json	新しいローカライズエントリの追加。
package.json	新しい依存関係@types/uuidとuuidの追加。
src/components/...	リアルタイム通信、メッセージ処理、ユーザー入力管理の機能向上。
src/features/chat/...	チャット処理ロジックの改善、メッセージ処理の簡素化。
src/features/googletts/..., src/features/koeiromap/..., src/features/messages/...	テキスト読み上げ機能に関連するファイルの削除。
src/features/lipSync/..., src/features/messages/...	音声合成機能のメソッド署名の更新、新しいパラメータの追加。
src/pages/api/...	AIチャット応答とテキスト読み上げ機能のための新しいAPIハンドラーの追加。

Possibly related PRs

• 環境変数周りの修正 #159: AIサービスに関連する環境変数の追加を含む変更があり、メインPRと直接関連しています。
• envファイル修正 & Azure設定プロパティ変更 #171: AIサービス用の新しい環境変数を導入しており、メインPRとの関連性があります。
• リリースブランチ #173: AIサービス用のキーの追加を含む環境変数の変更に焦点を当てており、メインPRと一致しています。

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.