Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

restructure existing blog posts #19

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 24 commits into from
Mar 17, 2024
Merged
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
Change ast-grep naming
  • Loading branch information
petrisorcoderabbit authored and harjotgill committed Mar 17, 2024
commit 00e15a3ac433a1176c8ac1edd54bd7db5bf93e3f
16 changes: 8 additions & 8 deletions docs/guides/prompt-customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,17 +52,17 @@ Descriptive test names are used to clearly convey the intent of each test.
## Abstract Syntax Tree (AST) instructions

:::note
**Deep dive into AST patterns and AST-Grep rules**
**Deep dive into AST patterns and ast-grep rules**
- AST patterns [wikipedia](https://en.wikipedia.org/wiki/Abstract_syntax_tree)
- AST-grep [official documentation](https://ast-grep.github.io/guide/rule-config.html) for detailed guides.
- ast-grep [official documentation](https://ast-grep.github.io/guide/rule-config.html) for detailed guides.
:::

This section explains how to add custom code review instructions using AST-Grep rules. AST-Grep is a tool used for searching code using abstract syntax trees (AST) patterns.
This section explains how to add custom code review instructions using ast-grep rules. ast-grep is a tool used for searching code using abstract syntax trees (AST) patterns.

By default, you can add AST-Grep rules by following these steps:
By default, you can add ast-grep rules by following these steps:
1. Create a folder that keeps all the ast-grep rules in your project directory.
2. Add individual `.yaml` files for each AST-Grep rule within the newly created folder.
3. Ensure that each `.yaml` file contains the necessary AST-Grep rule configurations.
2. Add individual `.yaml` files for each ast-grep rule within the newly created folder.
3. Ensure that each `.yaml` file contains the necessary ast-grep rule configurations.
4. Ensure that all rules contains a `message` property, that will be used in the review process.
5. Add the rules folder to the `.coderabbit.yml` file under `tools.ast-grep` configuration.

Expand Down Expand Up @@ -236,7 +236,7 @@ rule:

### Multiple Languages Support

CodeRabbit supports multiple programming languages for defining AST-Grep rules.
CodeRabbit supports multiple programming languages for defining ast-grep rules.

- JavaScript
- Typescript
Expand All @@ -248,7 +248,7 @@ CodeRabbit supports multiple programming languages for defining AST-Grep rules.
- Python
- C

Below are examples of AST-Grep rules in different languages:
Below are examples of ast-grep rules in different languages:

#### JavaScript
**Importing files without an extension is not allowed**
Expand Down