Skip to content

Commit

Permalink
remove daily standup guide
Browse files Browse the repository at this point in the history
  • Loading branch information
harjotgill committed Apr 15, 2024
1 parent 448501a commit 901a550
Show file tree
Hide file tree
Showing 10 changed files with 23 additions and 73 deletions.
1 change: 1 addition & 0 deletions docs/guides/coderabbit-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: CodeRabbit Commands
sidebar_label: CodeRabbit Commands
description: Learn how to manage your PR reviews with CodeRabbit commands.
sidebar_position: 1
---

Manage your PR reviews with the following commands:
Expand Down
1 change: 1 addition & 0 deletions docs/guides/configure-coderabbit.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ description:
CodeRabbit offers various configuration options to tailor the reviews to your
specific requirements. Configuration can be made using one of the below
options.
sidebar_position: 2
---

CodeRabbit offers various configuration options to tailor the reviews to your
Expand Down
58 changes: 0 additions & 58 deletions docs/guides/daily-standup-report.md

This file was deleted.

Binary file removed docs/guides/images/report-disabled.png
Binary file not shown.
Binary file removed docs/guides/images/report-schedule.png
Binary file not shown.
Binary file removed docs/guides/images/report-slack.png
Binary file not shown.
Binary file removed docs/guides/images/report.png
Binary file not shown.
Binary file removed docs/guides/images/slack-access.png
Binary file not shown.
25 changes: 14 additions & 11 deletions docs/guides/review-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ description:
CodeRabbit offers various customization options to tailor the reviews to your
specific requirements. Customizations can be made using one of the below
options.
sidebar_position: 3
---

### Path-based instructions {#path-based}
Expand Down Expand Up @@ -114,8 +115,8 @@ rule:
follows: { regex: "can|use|any" }
precedes: { kind: "multi_keys", pattern: "in.sub" }
# composite rule
all: [ { pattern: "match.all" }, { kind: "match_all" } ]
any: [ { pattern: "match.any" }, { kind: "match_any" } ]
all: [{ pattern: "match.all" }, { kind: "match_all" }]
any: [{ pattern: "match.any" }, { kind: "match_any" }]
not: { pattern: "not.this" }
matches: "utility-rule"
```
Expand Down Expand Up @@ -297,18 +298,19 @@ rule:
### Packages

A package is what allows you to share rules across multiple projects.
Essentially, a package is a collection of ast-grep rules.
Essentially, a package is a collection of `ast-grep` rules.

Coderabbit provides a set of packages that you can use out of the box. You can
CodeRabbit provides a set of packages that you can use out of the box. You can
also create your own packages and share them with the community or just use them
within your organization.

Packages provided by Coderabbit are:
Packages provided by CodeRabbit are:

- `ast-grep-essentials`: A set of essential security rules. Because we value security, this package gets
its own property in the `.coderabbit.yml` file, to make it easier to install and not overwrite. Check
the [package repository](https://github.com/coderabbitai/ast-grep-essentials)
for more information.
- `ast-grep-essentials`: A set of essential security rules. Because we value
security, this package gets its own property in the `.coderabbit.yml` file, to
make it easier to install and not overwrite. Check the
[package repository](https://github.com/coderabbitai/ast-grep-essentials) for
more information.

To use a package, you need to add the package name to the `packages` field in
the `.coderabbit.yml` file.
Expand Down Expand Up @@ -344,8 +346,9 @@ my-awesome-project # project root
| |- is-literal.yml
```

**rules** and **utils** directories are keywords, and it should be the same. Inside each directory, the structure is up
to you. You can also have any other root directories or files beside the two shown above.
**rules** and **utils** directories are keywords, and it should be the same.
Inside each directory, the structure is up to you. You can also have any other
root directories or files beside the two shown above.

- package name should be in the format `organization/repository`

Expand Down
11 changes: 7 additions & 4 deletions docs/integrations/self-hosted-gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,15 @@ organization.
If this is the first time you are signing up with your instance, we need an
admin access token for setting up the CodeRabbit.


#### **Why do we need the Admin Access Token?**

Admin access token is required to set up a new CodeRabbit bot user within your self-managed instance.
The token is needed only once during the initial setup process and is not stored in our database. Once the token is generated, you can set its minimum expiration period. This is the standard approach used by other products in this category.
This is not automatically installing the CodeRabbit app across all projects. You will add CodeRabbit manually on the projects you wish, as the next step.
Admin access token is required to set up a new CodeRabbit bot user within your
self-managed instance. The token is needed only once during the initial setup
process and is not stored in our database. Once the token is generated, you can
set its minimum expiration period. This is the standard approach used by other
products in this category. This is not automatically installing the CodeRabbit
app across all projects. You will add CodeRabbit manually on the projects you
wish, as the next step.

#### **Generating Admin Personal Access token**

Expand Down

0 comments on commit 901a550

Please sign in to comment.