Update FAQ

[hasit]

Summary by CodeRabbit

• Documentation
  • Simplified the explanation of access permissions required by CodeRabbit for repository interactions, making it more user-friendly.
  • Users can now review permissions during the installation process without technical jargon.

[coderabbitaidev]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request simplify the explanation of access permissions required by CodeRabbit for repository interactions. The original detailed specific access requirements for GitHub and GitLab, while the revised text provides a more general statement, indicating that users can review permissions during installation. This modification aims to make the documentation more user-friendly.

Changes

Files	Change Summary
docs/faq.md	Simplified the explanation of access permissions required by CodeRabbit, removing specific details for GitHub and GitLab.

Possibly related PRs

• Update introduction and CodeRabbit documentation #64: Updates documentation related to integrating CodeRabbit with GitLab, potentially addressing access permissions relevant to this PR.
• 📝 Document that we support GitLab 16+ #85: Documents compatibility with GitLab versions, which may relate to the access permissions needed for different GitLab setups mentioned in this PR.

Suggested labels

documentation

Suggested reviewers

• @
• @

---

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 generate interesting stats about this repository and render them as a table.
  -- @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.

Early access features: enabled

We are currently testing the following features in early access:

• OpenAI o1 for code reviews: OpenAI's new o1 model is being tested for code reviews. This model has advanced reasoning capabilities and can provide more detailed feedback on your code.

Note:

• You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
• • Please join our Discord Community to provide feedback and report issues on the discussion post.