修改中英文 README，修复 Azure OpenAI 文档的误导和一些用语用词的小问题等 #5049
Conversation
|
@Sha1rholder is attempting to deploy a commit to the NextChat Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThe recent updates enhance the internationalization (I18n) language options and refine the deployment instructions for Vercel in the README files. These changes include adjustments to API configurations, such as OpenAI, Azure, Google, and others, and address clarity and consistency in the Chinese deployment guide. Overall, these improvements aim to streamline deployment processes and provide a clearer, more user-friendly experience. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
|
Your build has completed! |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
README.md (1)
Line range hint
161-293: Environment Variables Section ReviewYou've made several changes to the environment variables, mostly removing the "optional" designation and specifying some as "important". This is a significant change as it affects how users will perceive the necessity of these variables.
CODE(important): This change is crucial because it emphasizes the importance of setting this variable for security reasons. However, the description could be improved to explain why it is important.- Removal of "optional": This is a good change for simplifying the documentation. However, ensure that it is clear in the documentation which variables are truly optional and which are not to avoid confusion.
Overall, these changes should help users better understand the setup requirements and the importance of certain variables.
However, consider adding more detailed descriptions for each variable to help users understand their use cases better.
Would you like me to help draft these descriptions or open a GitHub issue to track this enhancement?
Tools
LanguageTool
[style] ~192-~192: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...zure Api Key. ###AZURE_API_VERSIONAzure Api Version, find it at [Azure Document...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~212-~212: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...aude Api version. ###ANTHROPIC_URLanthropic claude Api Url. ###BAIDU_API_KEYB...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~224-~224: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...YBaidu Secret Key. ###BAIDU_URLBaidu Api Url. ###BYTEDANCE_API_KEY` Byte...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- README.md (5 hunks)
- README_CN.md (5 hunks)
Files skipped from review due to trivial changes (1)
- README_CN.md
Additional context used
LanguageTool
README.md
[style] ~192-~192: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...zure Api Key. ###AZURE_API_VERSIONAzure Api Version, find it at [Azure Document...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~212-~212: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...aude Api version. ###ANTHROPIC_URLanthropic claude Api Url. ###BAIDU_API_KEYB...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~224-~224: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...YBaidu Secret Key. ###BAIDU_URLBaidu Api Url. ###BYTEDANCE_API_KEY` Byte...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Additional comments not posted (2)
README.md (2)
50-50: Review of I18n Language OptionsThe I18n language options have been updated to include a wider range of languages. This change enhances the accessibility and internationalization of the project.
127-127: Clarification in Deployment InstructionsThe update to the deployment instructions link is a good improvement for clarity.
|
我觉得可选这个标识还是要保留，或者提前声明一下，不然真的有人会不知道哪个要填哪个不填 |
I think the optional symbol should be retained or declared in advance, otherwise some people will really not know which one needs to be filled in and which one should not. |
但其实没有一个是必须填写的 |
But in fact, none of them are required to be filled in. |
README.md
Outdated
|
|
||
| Baidu Secret Key. | ||
|
|
||
| ### `BAIDU_URL` (optional) | ||
| ### `BAIDU_URL` |
There was a problem hiding this comment.
因为原本的环境变量只有一个OPENAI_API_KEY是(required)而其他所有变量都是(optional)，但实际如果不使用openai原生api而是使用类似azure openai之类的话，这个环境变量也不是必填的
我看到这个库最近一次更新了，我的pr和这个最新的commit有冲突，于是关闭了。不过我还是建议把(optional)删了因为会引起误导
README.md
Outdated
|
|
||
| > Default: `https://api.openai.com` |
💻 变更类型 | Change Type
🔀 变更说明 | Description of Change
BASE_URL以增强可阅读性和简洁性📝 补充信息 | Additional Information
这个pr比较仓促，中英文两个版本的 README 在这次修改后还是有很多逻辑不顺，影响使用的地方，需要整个进行一下大改。有些内容中文文档有但英文文档没有，有些英文有中文没有。我觉得英文文档和中文文档完全分开写会更好，就在英文文档开头留个引导到中文文档的链接即可，这样引导汉语用户直接看中文会降低很多使用难度。我计划这两天重写一下文档，应该能大幅提高文档的可使用性和简洁性，不过还是需要先征求一下主要贡献者的同意
Summary by CodeRabbit