Skip to content

Remove llm models faq #103

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

Merged
merged 2 commits into from
Oct 3, 2024
Merged

Remove llm models faq #103

merged 2 commits into from
Oct 3, 2024

Conversation

hasit
Copy link
Contributor

@hasit hasit commented Oct 3, 2024

Summary by CodeRabbit

  • Documentation
    • Removed the section on "What Large Language Models does CodeRabbit use?" from the FAQ.
    • Made clarifications and adjustments throughout the remaining sections for improved clarity and conciseness.

@hasit hasit self-assigned this Oct 3, 2024
Copy link
Contributor

coderabbitaidev bot commented Oct 3, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The document docs/faq.md has been updated by removing the section titled "What Large Language Models does CodeRabbit use?" which previously provided details about the use of OpenAI's gpt-4-turbo and gpt-3.5-turbo models. The remaining content has been clarified and adjusted for conciseness, while the overall structure of the FAQ remains unchanged, continuing to cover general inquiries, subscription details, usage and configuration, and integration.

Changes

File Change Summary
docs/faq.md Removed section on "What Large Language Models does CodeRabbit use?" and made clarifications throughout remaining sections.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FAQ
    User->>FAQ: Request information
    FAQ-->>User: Provide general inquiries
    FAQ-->>User: Provide subscription details
    FAQ-->>User: Provide usage and configuration
    FAQ-->>User: Provide integration details
Loading

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitaidev in a new review comment at the desired location with your query. Examples:
    • @coderabbitaidev generate unit testing code for this file.
    • @coderabbitaidev modularize this function.
  • PR comments: Tag @coderabbitaidev 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:
    • @coderabbitaidev gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitaidev read src/utils.ts and generate unit testing code.
    • @coderabbitaidev read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitaidev 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)

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

Other keywords and placeholders

  • Add @coderabbitaidev ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitaidev summary or @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitaidev or @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

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: ae47e75
Status:⚡️  Build in progress...

View logs

@hasit hasit merged commit c52c260 into main Oct 3, 2024
1 check was pending
@hasit hasit deleted the hasit/docs-cleanup branch October 3, 2024 22:36
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