doc: fix Azure docs

[arloor]

💻 变更类型 | Change Type

• feat
• fix
• refactor
• perf
• style
• test
• docs
• ci
• chore
• build

🔀 变更说明 | Description of Change

Modify docs about AZURE_URL and CUSTOM_MODELS

📝 补充信息 | Additional Information

Fix the description mentioned in [Doc]文档似乎不是很清晰

Summary by CodeRabbit

• Documentation
  • Simplified Azure URL examples to enhance clarity.
  • Added detailed instructions for customizing model names and deployment names for Azure and ByteDance.
  • Clarified how to enable or disable default models for Azure and ByteDance.

[vercel]

@arloor is attempting to deploy a commit to the NextChat Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

The recent updates to the documentation focus on simplifying the configuration URLs for Azure and ByteDance deployments. The examples for AZURE_URL have been streamlined, eliminating the placeholder for deployment names. Additionally, there are enhanced instructions for customizing model and deployment names for both Azure and ByteDance. The documentation now provides clear guidelines on enabling or disabling default models for these services, ensuring a more user-friendly setup process.

Changes

Files	Change Summaries
README.md	Updated Azure URL example, added instructions for customizing model and deployment names for Azure and ByteDance. Clarified enabling/disabling default models for Azure and ByteDance.
README_CN.md	Refined Azure URL format, adjusted model configurations for Azure and ByteDance, included specific instructions with examples.

Poem

In docs clear and bright, we streamline the way,
Configs for Azure, ByteDance now hold sway.
Models named with ease, deployments set to flow,
A simpler path for all, let the knowledge grow. 🌟
So here's a cheer, with changes in sight,
For a future bright and configs done right!

---

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?

Share

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[arloor]

#5007

[Issues-translate-bot]

Bot detected the issue body's language is not English, translate it automatically.

---

#5007

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ec95292 and 348c1a7.

Files selected for processing (2)

• README.md (2 hunks)
• README_CN.md (2 hunks)

Additional comments not posted (4)

README_CN.md (2)

97-97: Updated Azure URL format

The updated AZURE_URL format simplifies the configuration by removing the deployment name. This change aligns with the PR's goal to streamline Azure configurations.

---

188-189: Enhanced model configuration syntax for Azure

The new syntax for CUSTOM_MODELS allows specifying model names and deployment names for Azure, enhancing flexibility and clarity. This update supports the PR's objective to improve documentation clarity and user guidance.

README.md (2)

183-183: Simplified Azure URL example

The updated AZURE_URL example is simplified, removing the deployment name placeholder, which should help users in setting up their Azure configurations more straightforwardly.

---

278-278: Custom model configuration for Azure and ByteDance

This change introduces a more flexible way to configure model names and deployment names for Azure and ByteDance, enhancing the documentation's clarity and usability.

[github-actions]

Your build has completed!

Preview deployment