Skip to content
This repository was archived by the owner on Aug 16, 2025. It is now read-only.

restructure existing blog posts #19

Merged
merged 24 commits into from
Mar 17, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
5179dea
format blog file
harjotgill Mar 2, 2024
c0e81f1
format all blog files
harjotgill Mar 2, 2024
f777247
hide version 1 schema
harjotgill Mar 1, 2024
26799b5
Update faq.md
guritfaq Mar 7, 2024
2ba4987
Fix images for light and dark mode. Made improvements to docs (#22)
karan925 Mar 12, 2024
a059d97
Add ast-grep documentation page
petrisorcoderabbit Mar 8, 2024
9941a21
Update the ast-grep documentation to include the coderabbit config fi…
petrisorcoderabbit Mar 8, 2024
82d7eed
Fix language review
petrisorcoderabbit Mar 11, 2024
02189bf
Update coderabbit.yaml schema for ast-grep tool naming
petrisorcoderabbit Mar 12, 2024
98f0ef6
Update coderabbig guide page with new coderabbit.yaml changes
petrisorcoderabbit Mar 12, 2024
d705086
Update 2023-11-13-boosting-engineering-efficiency.md
guritfaq Mar 12, 2024
d0bd7ba
Move ast-grep documentation under the prompt-customization page
petrisorcoderabbit Mar 13, 2024
00e15a3
Change ast-grep naming
petrisorcoderabbit Mar 13, 2024
c59229f
Correct grammar for ast-grep documentation
petrisorcoderabbit Mar 13, 2024
c154d61
update faqs
karan925 Mar 12, 2024
8b47f3f
Update Discord link in Footer component (#25)
karan925 Mar 15, 2024
dd21258
restructure existing blog posts
harjotgill Mar 17, 2024
2cbb989
merge
harjotgill Mar 17, 2024
a5adb95
restructure existing docs
harjotgill Mar 17, 2024
82aa358
restructure existing docs
harjotgill Mar 17, 2024
6a91e80
review feedback
harjotgill Mar 17, 2024
3dc4177
add preview image
harjotgill Mar 17, 2024
0cb9eb9
use directory instead of folder terminology
harjotgill Mar 17, 2024
6c75ada
nit
harjotgill Mar 17, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
use directory instead of folder terminology
  • Loading branch information
harjotgill committed Mar 17, 2024
commit 0cb9eb9b7cddec246f28b5977b4ecf2845dbff6c
113 changes: 56 additions & 57 deletions docs/guides/customize-coderabbit.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ reviews:
- "feat/.*"
tools:
ast-grep:
rules_folder: "custom-rules-folder-name"
utils_folder: "custom-utils-folder-name"
rules_directory: "custom-rules-directory-name"
utils_directory: "custom-utils-directory-name"
chat:
auto_reply: true
```
Expand All @@ -70,47 +70,48 @@ repository.

YAML settings:

1. **language**: Set the language for reviews using the ISO language code. For
1. **`language`**: Set the language for reviews using the ISO language code. For
example, `"fr"` stands for French (default:`en`).

2. **early_access**: Enroll in the early access program to take advantage of
2. **`early_access`**: Enroll in the early access program to take advantage of
forthcoming features before their general release (default:`false`).

3. **reviews**: Configurations for the code reviews.
- **request_changes_workflow**: Enable Request Changes review workflow for
3. **`reviews`**: Configurations for the code reviews.
- **`request_changes_workflow`**: Enable request changes review workflow for
CodeRabbit reviews. (default: `false`).
- **high_level_summary**: CodeRabbit generates a high level summary of the
- **`high_level_summary`**: CodeRabbit generates a high-level summary of the
changes (default:`true`).
- **poem**: Indicates whether a creative poem should be included in the
- **`poem`**: Indicates whether a creative poem should be included in the
review (default:`true`).
- **review_status**: Indicates the status of the review (default:`true`).
- **collapse_walkthrough**: Collapses the walkthrough comment
- **`review_status`**: Indicates the status of the review (default:`true`).
- **`collapse_walkthrough`**: Collapses the walkthrough comment
(default:`false`).
- **path_filters**: Specifies file patterns to exclude or include for a
- **`path_filters`**: Specifies file patterns to exclude or include for a
review, such as `!dist/**` and `src/**.tsx`, using glob notation.
- **path_instructions**: Provides specific additional guidelines for code
- **`path_instructions`**: Provides specific additional guidelines for code
review based on file paths. In the given example, JavaScript files are
singled out for checks against the Google JavaScript style guide. File path
accepts glob pattern
- **auto_review**: Manages settings for automated code reviews, such as:
- **enabled**: Automated code review (default: `true`).
- **ignore_title_keywords**: Review will be ignored if a pull request title
contains one of the list of keywords (e.g., `"WIP"`, `"DO NOT MERGE"`).
- **labels**: Review will be triggered if a pull request contains one of
- **`auto_review`**: Manages settings for automated code reviews, such as:
- **`enabled`**: Automated code review (default: `true`).
- **`ignore_title_keywords`**: Review will be ignored if a pull request
title contains one of the list of keywords (e.g., `"WIP"`,
`"DO NOT MERGE"`).
- **`labels`**: Review will be triggered if a pull request contains one of
the list of labels.
- **drafts**: Determines whether draft pull requests are reviewed (default:
`true`).
- **base_branches**: A list of base branches where the reviews will occur
- **`drafts`**: Determines whether draft pull requests are reviewed
(default: `true`).
- **`base_branches`**: A list of base branches where the reviews will occur
apart from the default branch. Accepts regex pattern.
- **tools**: Configurations for the tools used in the review.
- **ast-grep**: Configurations for the ast-grep tool.
- **rules_folder**: The folder name where the custom ast-grep rules are
stored.
- **utils_folder**: The folder name where the custom ast-grep utils are
stored.
4. **chat**: Defines the behavior of CodeRabbit's bot in conversations.
- **auto_reply**: The bot automatically replies without the need of the user
tagging it (default: `true`).
- **`tools`**: Configurations for the tools used in the review.
- **`ast-grep`**: Configurations for the `ast-grep` tool.
- **`rules_directory`**: The directory name where the custom `ast-grep`
rules are stored.
- **`utils_directory`**: The directory name where the custom `ast-grep`
utils are stored.
4. **`chat`**: Defines the behavior of CodeRabbit's bot in conversations.
- **`auto_reply`**: The bot automatically replies without the need of the
user tagging it (default: `true`).

Refer:
[CodeRabbit Configuration Schema](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json).
Expand Down Expand Up @@ -157,47 +158,45 @@ settings:
tools:
# tools configuration for ast-grep
ast-grep:
rules_folder: "custom-rules-folder-name"
utils_folder: "custom-utils-folder-name"
rules_directory: "custom-rules-directory-name"
utils_directory: "custom-utils-directory-name"
```

<!-- ![code](./images/ymlrabbit.png) -->

This configuration file consists of the following settings:

1. **enable_draft_pr_reviews**: Set to **false** to disable draft pull
1. **`enable_draft_pr_reviews`**: Set to **`false`** to disable draft pull
request(PR) reviews.
2. **additional_branches_to_be_reviewed**: Define additional branches to be
2. **`additional_branches_to_be_reviewed`**: Define additional branches to be
reviewed besides the default branch.
3. **disable_high_level_summary**: If set to **true**, disables high-level
3. **`disable_high_level_summary`**: If set to **`true`**, disables high-level
summary generation.
4. **path_based_instructions**: Allows you to specify instructions based on file
paths. In this example, instructions for Python and JavaScript files are
4. **`path_based_instructions`**: Allows you to specify instructions based on
file paths. In this example, instructions for Python and JavaScript files are
provided, encouraging adherence to the Google style guide.
5. **ignored_pr_titles**: Specifies ignored PR titles, in this case, "WIP" (Work
in Progress).
6. **review_language**: Sets the review language to French ("fr").
7. **disable_poem**: If set to **false**, enables the "poem" feature.
8. **early_access_program**: Determines whether to enable the early access
program (set to **false** in this case).
9. **exclude_file_patterns**: Specifies patterns for excluding certain files
5. **`ignored_pr_titles`**: Specifies ignored PR titles, in this case, "WIP"
(Work in Progress).
6. **`review_language`**: Sets the review language to French (`fr`).
7. **`disable_poem`**: If set to **`false`**, enables the "poem" feature.
8. **`early_access_program`**: Determines whether to enable the early access
program (set to **`false`** in this case).
9. **`exclude_file_patterns`**: Specifies patterns for excluding certain files
from review, such as `!dist/**` and `!**.md`.
10. **limit_reviews_by_label**: Limits reviews by label, targeting "first_bug"
10. **`limit_reviews_by_label`**: Limits reviews by label, targeting "first_bug"
label reviews.
11. **disable_review**: Totally disables automatic code reviews for the
11. **`disable_review`**: Totally disables automatic code reviews for the
repository.
12. **disable_review_status**: This is the comment posted for each incremental
12. **`disable_review_status`**: This is the comment posted for each incremental
review status. This removes the review status comment. Reviews will still
take place. However, optional comments added to the review status will not
be posted.
13. **collapse_walkthrough_comment**: Specifies whether to collapse walkthrough
comments on the review.
14. **tools**: Configurations for the tools used in the review.
- **ast-grep**: Configurations for the ast-grep tool.
- **rules_folder**: The folder name where the custom ast-grep rules are
stored.
- **utils_folder**: The folder name where the custom ast-grep utils are
stored.
13. **`collapse_walkthrough_comment`**: Specifies whether to collapse
walkthrough comments on the review.
14. **`tools`**: Configurations for the tools used in the review.
- **`ast-grep`**: Configurations for the `ast-grep` tool.
- **`rules_directory`**: The directory name where the custom `ast-grep`
rules are stored.
- **`utils_directory`**: The directory name where the custom `ast-grep`
utils are stored.

Refer:
[CodeRabbit configuration schema](https://coderabbit.ai/integrations/coderabbit-overrides.json).
Expand All @@ -224,7 +223,7 @@ section [Prompt Customization](/guides/prompt-customization)
feedback. CodeRabbit supports most of the widely used languages. The default
language is English.

**Disable High Level Summary:** This allows disabling high-level summary added
**Disable High-Level Summary:** This allows disabling high-level summary added
with the pull request description.

---
Expand Down
Loading