Skip to content

Commit

Permalink
update features list (#107)
Browse files Browse the repository at this point in the history
* update features list

* Fix typo in section title and add missing comma.

Co-authored-by: coderabbitaidev[bot] <142196860+coderabbitaidev[bot]@users.noreply.github.com>

* the irony is not lost on us...

---------

Co-authored-by: coderabbitaidev[bot] <142196860+coderabbitaidev[bot]@users.noreply.github.com>
  • Loading branch information
alexcoderabbitai and coderabbitaidev[bot] authored Oct 15, 2024
1 parent 0810c74 commit 9f5cb6a
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs/about/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,12 @@ changes. Just comment on the CodeRabbit review to start the conversation.
CodeRabbit learns from your interactions and gets smarter over time. The more
you chat, the better it gets.

We support:

- Inline Comments in Pull Request File Diffs
- Comments in Pull Requests
- Comments in Git Issues

![Chat](/img/about/chat.png)

### 4. Issue Validation {#issue-validation}
Expand All @@ -52,3 +58,29 @@ Pull request changes are validated against the linked GitHub or GitLab issue and
identifies all other issues which might be affected by this change.

![Issue Validation](/img/about/issue-validation.png)

### 5. Sequence Diagrams {#sequence-diagrams}

CodeRabbit visualizes the changes occuring in any pull request using
[Mermaid Diagrams](https://mermaid.live/).

![Diagram](/img/about/diagram.png)

![Advanced Diagram](/img/about/advanced-diagram.png)

### 6. Commitable Suggestions {#commitable-suggestions}

For quick fixes, CodeRabbit offers one button solution to commit AI recommended
changes!

![Commitable Suguestion](/img/about/committable-suggestion.png)

![Irony](/img/about/ironic-committable.png)

### 7. Learnings {#learnings}

CodeRabbit learns from user chat interactions to gain tribal knowledge on your
repositories and organization. CodeRabbit will apply and update these learnings
in future reviews

![Learnings](/img/about/learnings.png)
Binary file added static/img/about/advanced-diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/about/diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/about/ironic-committable.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/about/learnings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9f5cb6a

Please sign in to comment.