Skip to content

Fix images for light and dark mode. Made improvements to docs #22

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 7 commits into from
Mar 12, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Fix typos and capitalize JavaScript in code review instructions
  • Loading branch information
karan925 committed Mar 12, 2024
commit 1a02b6590283ce2348bf6f835acb38d75c980a9a
2 changes: 1 addition & 1 deletion docs/get-started/analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Dashboard displays the following information:
![Untitled](./images/cr_dash_dark.png#gh-dark-mode-only)
![Untitled](./images/cr_dash_light.png#gh-light-mode-only)

Access the list of recent pull request reviewed.
Access the list of recent pull requests reviewed.

![Untitled](./images/cr_history_dark.png#gh-dark-mode-only)
![Untitled](./images/cr_history_light.png#gh-light-mode-only)
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/customize-coderabbit.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ settings:
path_based_instructions:
- path: "**/*.js"
instructions:
"Review the javascript code against the Google Javascript style guide
"Review the JavaScript code against the Google JavaScript style guide
and point out any mismatches"
- path: "tests/**/*"
instructions:
Expand Down Expand Up @@ -205,7 +205,7 @@ Reviews can also be customized through the UI under repository settings:

[](../get-started/images/tailor2.png)

**Path based instructions :** Provide additional review guidelines based on the
**Path-based instructions :** Provide additional review guidelines based on the
file paths using glob patterns.

For further guidance, please refer this
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/prompt-customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ image: "/preview_meta.jpg"
<meta name="twitter:description" content="Accelerate Code Reviews with AI" />
</head>

### Path based instructions[](https://coderabbit.ai/docs/prompt-customization#path-based-instructions)
### Path-based instructions[](https://coderabbit.ai/docs/prompt-customization#path-based-instructions)

This section explains how to add custom code review instructions for the entire project or specific file paths in your project using glob patterns. Developers can provide tailored review guidelines based on the file paths. These instructions are needed only if you want the reviewer to follow specific instructions besides the standard review.

Expand All @@ -32,7 +32,7 @@ Adding file path prompts allows developers to specify custom instructions for di

**path:** `**/*.js`

**instructions:** Review the javascript code against the Google Javascript style guide and point out any mismatches
**instructions:** Review the JavaScript code against the Google JavaScript style guide and point out any mismatches

**path:** `tests/**.*`

Expand Down