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

Rewrite the Quickstart as a full tutorial. #284

Merged
merged 11 commits into from
Apr 23, 2025
Prev Previous commit
Next Next commit
Minor tweaks
  • Loading branch information
jmacdotorg committed Apr 16, 2025
commit 9d1dfb60ba4f956821a79f29fa826f3dbdf6fba8
6 changes: 1 addition & 5 deletions docs/getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,16 +79,14 @@ Use your usual Git workflow to perform the following steps in the `coderabbit-te
After a few moments, CodeRabbit responds to the pull request using the `@coderabbitai` GitHub account. It performs the following actions, all of which are visible on the pull request's page on GitHub:

* If you didn't write a pull request summary, then Code Rabbit adds a new summary to the pull request.

* CodeRabbit posts a comment titled **Walkthrough** containing analysis and commentary about the content of the pull request.

* CodeRabbit attaches a detailed code review to the pull request as another comment.

Part of the review resembles the following screenshot:

![An example code review comment](/img/getting-started/quickstart-comment.png)

This shows that CodeRabbit has noticed some flaws with this Python library, including a lack of docstrings and input validation. The review comment identifies these flaws, and suggests how you might implement them.
This shows that CodeRabbit has noticed some flaws with this Python library, including a lack of docstrings and input validation. The review comment identifies these flaws, and suggests how you might improve them.

## Ask CodeRabbit for more information

Expand Down Expand Up @@ -119,9 +117,7 @@ After CodeRabbit reviews a pull request, you can converse with it about its revi
After a few moments, CodeRabbit does the following:

* CodeRabbit creates a new branch, based on `add-utils`.

* CodeRabbit commits changes to the branch that adds suggested docstrings to `add-utils`.

* CodeRabbit opens a new pull request between the new branch and `add-utils`.

## Clean up
Expand Down
Loading