Rewrite the Quickstart as a tutorial. #283
Conversation
…code-review comment.
WalkthroughThe quickstart documentation was significantly expanded and restructured into a comprehensive, step-by-step tutorial for integrating and using CodeRabbit with a GitHub repository. The updated guide now covers the entire onboarding process, including repository creation, integration steps, a practical code review workflow example, interactive features, and post-review actions. Visual aids and detailed instructions were added, transforming the document from a brief outline into an in-depth onboarding resource for new users. Changes
Poem
Tip ⚡💬 Agentic Chat (Pro Plan, General Availability)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (3)
docs/getting-started/quickstart.md (3)
135-139: Use consistent unordered list style.The unordered list at the end of the document uses dashes (
-) instead of asterisks (*), which is flagged by markdownlint (MD004). For consistency with the rest of the documentation, use asterisks.Apply this diff to fix the issue:
-- [Integrate CodeRabbit](http://localhost:3000/platforms/) with your repositories on GitHub, GitLab, Azure DevOps, or Bitbucket. -- [Configure CodeRabbit](/getting-started/configure-coderabbit) beyond its default settings. -- [Add custom review instructions](/guides/review-instructions). -- [Get support for CodeRabbit](/getting-started/support). -- [Learn more about how CodeRabbit works](/overview/why-coderabbit). +* [Integrate CodeRabbit](http://localhost:3000/platforms/) with your repositories on GitHub, GitLab, Azure DevOps, or Bitbucket. +* [Configure CodeRabbit](/getting-started/configure-coderabbit) beyond its default settings. +* [Add custom review instructions](/guides/review-instructions). +* [Get support for CodeRabbit](/getting-started/support). +* [Learn more about how CodeRabbit works](/overview/why-coderabbit).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
135-135: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
136-136: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
137-137: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
138-138: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
139-139: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
91-91: Consider stronger wording for clarity.The phrase "This shows that CodeRabbit has noticed some flaws..." could be strengthened for clarity and impact. Consider using "This indicates" or "This demonstrates" instead.
Apply this diff to improve the wording:
-This shows that CodeRabbit has noticed some flaws with this Python library, including a lack of docstrings and input validation. +This demonstrates that CodeRabbit has identified some flaws with this Python library, including a lack of docstrings and input validation.🧰 Tools
🪛 LanguageTool
[style] ~91-~91: Consider using a different verb to strengthen your wording.
Context: ...g-started/quickstart-comment.png) This shows that CodeRabbit has noticed some flaws ...(SHOW_INDICATE)
121-125: Vary sentence structure for readability.Three successive sentences begin with "CodeRabbit," which can be repetitive. Consider rephrasing for better flow.
Apply this diff to improve readability:
- * 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`. +* CodeRabbit creates a new branch, based on `add-utils`. +* It then commits changes to the branch that add suggested docstrings to `add-utils`. +* Finally, a new pull request is opened between the new branch and `add-utils`.🧰 Tools
🪛 LanguageTool
[style] ~125-~125: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...uggested docstrings toadd-utils. * CodeRabbit opens a new pull request between the ne...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 markdownlint-cli2 (0.17.2)
121-121: Hard tabs
Column: 1(MD010, no-hard-tabs)
123-123: Hard tabs
Column: 1(MD010, no-hard-tabs)
125-125: Hard tabs
Column: 1(MD010, no-hard-tabs)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
static/img/getting-started/quickstart-comment.pngis excluded by!**/*.png,!**/*.png
📒 Files selected for processing (1)
docs/getting-started/quickstart.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/getting-started/quickstart.md
[style] ~91-~91: Consider using a different verb to strengthen your wording.
Context: ...g-started/quickstart-comment.png) This shows that CodeRabbit has noticed some flaws ...
(SHOW_INDICATE)
[style] ~125-~125: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...uggested docstrings to add-utils. * CodeRabbit opens a new pull request between the ne...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 markdownlint-cli2 (0.17.2)
docs/getting-started/quickstart.md
61-61: Hard tabs
Column: 1
(MD010, no-hard-tabs)
61-61: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
62-62: Hard tabs
Column: 1
(MD010, no-hard-tabs)
64-64: Hard tabs
Column: 1
(MD010, no-hard-tabs)
65-65: Hard tabs
Column: 1
(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 1
(MD010, no-hard-tabs)
68-68: Hard tabs
Column: 1
(MD010, no-hard-tabs)
69-69: Hard tabs
Column: 1
(MD010, no-hard-tabs)
71-71: Hard tabs
Column: 1
(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 1
(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 1
(MD010, no-hard-tabs)
99-99: Hard tabs
Column: 1
(MD010, no-hard-tabs)
99-99: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
100-100: Hard tabs
Column: 1
(MD010, no-hard-tabs)
101-101: Hard tabs
Column: 1
(MD010, no-hard-tabs)
103-103: Hard tabs
Column: 1
(MD010, no-hard-tabs)
105-105: Hard tabs
Column: 1
(MD010, no-hard-tabs)
106-106: Hard tabs
Column: 1
(MD010, no-hard-tabs)
107-107: Hard tabs
Column: 1
(MD010, no-hard-tabs)
108-108: Hard tabs
Column: 1
(MD010, no-hard-tabs)
109-109: Hard tabs
Column: 1
(MD010, no-hard-tabs)
111-111: Hard tabs
Column: 1
(MD010, no-hard-tabs)
115-115: Hard tabs
Column: 1
(MD010, no-hard-tabs)
115-115: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
116-116: Hard tabs
Column: 1
(MD010, no-hard-tabs)
117-117: Hard tabs
Column: 1
(MD010, no-hard-tabs)
119-119: Hard tabs
Column: 1
(MD010, no-hard-tabs)
121-121: Hard tabs
Column: 1
(MD010, no-hard-tabs)
123-123: Hard tabs
Column: 1
(MD010, no-hard-tabs)
125-125: Hard tabs
Column: 1
(MD010, no-hard-tabs)
135-135: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
136-136: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
137-137: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
138-138: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
139-139: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
🔇 Additional comments (1)
docs/getting-started/quickstart.md (1)
1-140: Comprehensive, clear, and user-friendly tutorial rewrite.The overall structure, clarity, and step-by-step approach of the new tutorial are excellent. The instructions are accurate, the flow is logical, and the document provides a much improved onboarding experience for new users. Visual aids and links are well-placed.
🧰 Tools
🪛 LanguageTool
[style] ~91-~91: Consider using a different verb to strengthen your wording.
Context: ...g-started/quickstart-comment.png) This shows that CodeRabbit has noticed some flaws ...(SHOW_INDICATE)
[style] ~125-~125: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...uggested docstrings toadd-utils. * CodeRabbit opens a new pull request between the ne...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 markdownlint-cli2 (0.17.2)
61-61: Hard tabs
Column: 1(MD010, no-hard-tabs)
61-61: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
62-62: Hard tabs
Column: 1(MD010, no-hard-tabs)
64-64: Hard tabs
Column: 1(MD010, no-hard-tabs)
65-65: Hard tabs
Column: 1(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 1(MD010, no-hard-tabs)
68-68: Hard tabs
Column: 1(MD010, no-hard-tabs)
69-69: Hard tabs
Column: 1(MD010, no-hard-tabs)
71-71: Hard tabs
Column: 1(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 1(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 1(MD010, no-hard-tabs)
99-99: Hard tabs
Column: 1(MD010, no-hard-tabs)
99-99: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
100-100: Hard tabs
Column: 1(MD010, no-hard-tabs)
101-101: Hard tabs
Column: 1(MD010, no-hard-tabs)
103-103: Hard tabs
Column: 1(MD010, no-hard-tabs)
105-105: Hard tabs
Column: 1(MD010, no-hard-tabs)
106-106: Hard tabs
Column: 1(MD010, no-hard-tabs)
107-107: Hard tabs
Column: 1(MD010, no-hard-tabs)
108-108: Hard tabs
Column: 1(MD010, no-hard-tabs)
109-109: Hard tabs
Column: 1(MD010, no-hard-tabs)
111-111: Hard tabs
Column: 1(MD010, no-hard-tabs)
115-115: Hard tabs
Column: 1(MD010, no-hard-tabs)
115-115: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
116-116: Hard tabs
Column: 1(MD010, no-hard-tabs)
117-117: Hard tabs
Column: 1(MD010, no-hard-tabs)
119-119: Hard tabs
Column: 1(MD010, no-hard-tabs)
121-121: Hard tabs
Column: 1(MD010, no-hard-tabs)
123-123: Hard tabs
Column: 1(MD010, no-hard-tabs)
125-125: Hard tabs
Column: 1(MD010, no-hard-tabs)
135-135: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
136-136: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
137-137: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
138-138: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
139-139: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
| ``` | ||
| @coderabbitai generate docstrings | ||
| ``` |
There was a problem hiding this comment.
Fix hard tabs and specify code block language in command example.
The code block for the GitHub command uses hard tabs and does not specify a language. Replace hard tabs with spaces and specify text as the language for clarity.
Apply this diff to fix the issues:
- ```
- @coderabbitai generate docstrings
- ```
+```text
+@coderabbitai generate docstrings
+```🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
115-115: Hard tabs
Column: 1
(MD010, no-hard-tabs)
115-115: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
116-116: Hard tabs
Column: 1
(MD010, no-hard-tabs)
117-117: Hard tabs
Column: 1
(MD010, no-hard-tabs)
| ``` | ||
| @coderabbitai Why do all of these functions need docstrings? Isn't it obvious enough what they do? | ||
| ``` |
There was a problem hiding this comment.
Fix hard tabs and specify code block language in comment example.
The code block for the GitHub comment uses hard tabs and does not specify a language. Replace hard tabs with spaces and specify text as the language for clarity.
Apply this diff to fix the issues:
- ```
- @coderabbitai Why do all of these functions need docstrings? Isn't it obvious enough what they do?
- ```
+```text
+@coderabbitai Why do all of these functions need docstrings? Isn't it obvious enough what they do?
+```🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
99-99: Hard tabs
Column: 1
(MD010, no-hard-tabs)
99-99: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
100-100: Hard tabs
Column: 1
(MD010, no-hard-tabs)
101-101: Hard tabs
Column: 1
(MD010, no-hard-tabs)
| ``` | ||
| # simple_utils.py - A tiny utility library | ||
|
|
||
| def reverse_string(text): | ||
| """Reverses the characters in a string.""" | ||
| return text[::-1] | ||
|
|
||
| def count_words(sentence): | ||
| return len(sentence.split()) | ||
|
|
||
| def celsius_to_fahrenheit(celsius): | ||
| return (celsius * 9/5) + 32 | ||
| ``` |
There was a problem hiding this comment.
Fix hard tabs and specify code block language in code snippet.
The code block for simple_utils.py uses hard tabs for indentation, which is discouraged in markdown and flagged by markdownlint (MD010). Additionally, the code block does not specify a language, which is flagged by MD040. Replace hard tabs with spaces and specify python as the language for syntax highlighting.
Apply this diff to fix the issues:
- ```
- # simple_utils.py - A tiny utility library
-
- def reverse_string(text):
- """Reverses the characters in a string."""
- return text[::-1]
-
- def count_words(sentence):
- return len(sentence.split())
-
- def celsius_to_fahrenheit(celsius):
- return (celsius * 9/5) + 32
- ```
+```python
+# simple_utils.py - A tiny utility library
+
+def reverse_string(text):
+ """Reverses the characters in a string."""
+ return text[::-1]
+
+def count_words(sentence):
+ return len(sentence.split())
+
+def celsius_to_fahrenheit(celsius):
+ return (celsius * 9/5) + 32
+```🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
61-61: Hard tabs
Column: 1
(MD010, no-hard-tabs)
61-61: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
62-62: Hard tabs
Column: 1
(MD010, no-hard-tabs)
64-64: Hard tabs
Column: 1
(MD010, no-hard-tabs)
65-65: Hard tabs
Column: 1
(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 1
(MD010, no-hard-tabs)
68-68: Hard tabs
Column: 1
(MD010, no-hard-tabs)
69-69: Hard tabs
Column: 1
(MD010, no-hard-tabs)
71-71: Hard tabs
Column: 1
(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 1
(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 1
(MD010, no-hard-tabs)
|
Closing this due to workflow changes; will re-open elsewhere. |
This rewrite of the Quickstart recasts the page as a tutorial, guiding the reader through letting CodeRabbit review a simple code change that they make to a test repository, and then chatting with the bot a bit.
This builds on the current Quickstart by continuing to demonstrate the ease of GitHub integration, and then immediately following up by prompting to user to make a small, specific pull request and observe how CodeRabbit responds. It also nudges the reader to try talking with CodeRabbit further and letting it generate docstrings, demonstrating some of its secondary features.