Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add DEEPSEEK_API_KEY and DEEPSEEK_URL in README #6001

Merged
merged 3 commits into from
Dec 30, 2024

Conversation

bestsanmao
Copy link
Contributor

@bestsanmao bestsanmao commented Dec 29, 2024

docs: add DEEPSEEK_API_KEY and DEEPSEEK_URL in README

Summary by CodeRabbit

  • New Features
    • Added support for DeepSeek API configuration with optional environment variables: DEEPSEEK_API_KEY and DEEPSEEK_URL.
  • Documentation
    • Updated README and README_CN with new DeepSeek API configuration options.

Copy link

vercel bot commented Dec 29, 2024

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

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Dec 29, 2024

Walkthrough

This pull request introduces two new optional environment variables, DEEPSEEK_API_KEY and DEEPSEEK_URL, in the NextChat project, documented in both the English and Chinese README files. Additionally, the DeepSeekApi class in deepseek.ts is modified to use accessStore.deepseekUrl for its base URL configuration. These changes enhance the project's ability to integrate with the DeepSeek API without altering existing functionality.

Changes

File Change Summary
README.md Added two new optional environment variables: DEEPSEEK_API_KEY and DEEPSEEK_URL
README_CN.md Added Chinese translations for the new DEEPSEEK_API_KEY and DEEPSEEK_URL environment variables
app/client/platforms/deepseek.ts Updated base URL configuration to use accessStore.deepseekUrl instead of accessStore.moonshotUrl

Possibly related PRs

Suggested reviewers

  • Dogtiti

Poem

🐰 A Rabbit's Ode to DeepSeek API 🤖
In README's realm, two vars appear,
DeepSeek's secrets now crystal clear.
With URL and key, a new path unfurled,
Connecting code to an AI-powered world!
Hop, hop, hooray for integration's might! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2a8a183 and b5d104c.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

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
🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
README_CN.md (1)

195-198: New optional environment variable DEEPSEEK_API_KEY.

This adds clarity for users configuring DeepSeek. Ensure that it’s validated or at least gracefully handled within the code, so the system doesn’t break if misconfigured or left empty.

README.md (1)

315-318: New optional environment variable DEEPSEEK_API_KEY.

This addition looks good; it helps clarify that an API key is needed for DeepSeek but not required if the feature is not used. Consider linking to relevant DeepSeek docs (internal or external) to guide developers on obtaining and managing their API key.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e1cb8e3 and 2a8a183.

📒 Files selected for processing (3)
  • README.md (1 hunks)
  • README_CN.md (1 hunks)
  • app/client/platforms/deepseek.ts (1 hunks)
🔇 Additional comments (3)
app/client/platforms/deepseek.ts (1)

38-38: Replaced moonshotUrl with deepseekUrl.

This aligns with the newly introduced environment variable logic and provides a more descriptive, context-specific naming. Ensure that any references to the older property are removed or updated in related files and that deepseekUrl is properly documented and tested.

README_CN.md (1)

199-202: New optional environment variable DEEPSEEK_URL.

Including this variable in the documentation completes the configuration instructions for DeepSeek. Verify that the code uses DEEPSEEK_URL as intended, and maintain consistency with the deepseekUrl property in your application stores or components.

README.md (1)

319-322: New optional environment variable DEEPSEEK_URL.

Documenting the base URL for DeepSeek is essential for a smooth setup. Ensure that readers understand how this setting is prioritized if they also configure other URLs or fallback logic. Looks well integrated with the environment variable documentation structure.

@Dogtiti Dogtiti merged commit d56566c into ChatGPTNextWeb:main Dec 30, 2024
1 check failed
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.

2 participants