search

coderabbitai / coderabbit-docs

Official documentation of CodeRabbit: AI Code Reviews
https://docs.coderabbit.ai
7 stars 4 forks source link

Update Schema config #120

Closed aravindputrevu closed 2 weeks ago

coderabbitai[bot] commented 2 weeks ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The pull request modifies the docs/configure-coderabbit.md document, clarifying configuration options for CodeRabbit. It explicitly lists the order of precedence for configuration methods, introduces a new section for migrating UI configurations to a YAML file, and emphasizes the necessity of the .coderabbit.yaml file in feature branches. Additionally, the link to the CodeRabbit Configuration Schema has been updated to a new hosting location. These changes aim to enhance user understanding and accessibility of configuration processes.

Changes

File Change Summary
docs/configure-coderabbit.md Clarified configuration options and order of precedence; added migration guidance for UI configs to YAML; emphasized necessity of .coderabbit.yaml in feature branches; updated link to CodeRabbit Configuration Schema.

Possibly related PRs

Suggested reviewers

🐇 In the land of CodeRabbit, we hop with delight,
Configurations are clearer, making work feel just right.
With YAML in hand, we migrate with ease,
Our features now shine, like the sun through the trees!
A new link awaits, guiding us true,
In the garden of coding, there's much we can do! 🌼

🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
cloudflare-workers-and-pages[bot] commented 2 weeks ago

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 49877a7
Status: ✅  Deploy successful!
Preview URL: https://b550153f.coderabbit-docs.pages.dev
Branch Preview URL: https://aravindputrevu-patch-1.coderabbit-docs.pages.dev

View logs