Skip to content

Commit dadaa81

Browse files
Prasad BhatPrasad Bhat
Prasad Bhat
authored and
Prasad Bhat
committed
docs: fixed lint errors
1 parent 2dc5eb8 commit dadaa81

19 files changed

+29
-57
lines changed

‎README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ Welcome to the official docs for [**CodeRabbit**](https://coderabbit.ai), the co
3838
## Getting Started
3939

4040
1. Make sure that you have the following prerequisites installed:
41-
4241
- [Node.js](https://nodejs.org/)
4342
- [pnpm](https://pnpm.io/installation)
4443

‎docs/getting-started/configure-coderabbit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ import YamlEditor from '@site/src/components/YamlEditor/YamlEditor';
5050
</div>
5151
</div>
5252

53-
The configuration file can be used to set various options.
53+
The configuration file can be used to set various options.
5454

5555
```mdx-code-block
5656
import SchemaViewer from '@site/src/components/SchemaViewer';

‎docs/getting-started/quickstart.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ description: See CodeRabbit in action, using a live GitHub repository.
55
sidebar_position: 1
66
---
77

8-
98
# Quickstart
109

1110
This tutorial gives you a hands-on demonstration of CodeRabbit, using a real, GitHub-based repository. It guides you through the following tasks:
@@ -130,8 +129,7 @@ After a few moments, CodeRabbit posts its reply, explaining its motivations for
130129
<p>If you prefer to skip docstrings for obvious utility functions in this project, that's perfectly reasonable. Would you like me to adjust my review approach regarding documentation for this repository?</p>
131130
</div>
132131

133-
In this case, CodeRabbit is offering to adjust its future behavior when reviewing changes to this repository. Instead, follow the next step to ask CodeRabbit to implement part of its suggestions.
134-
2. Post the following as another new comment:
132+
In this case, CodeRabbit is offering to adjust its future behavior when reviewing changes to this repository. Instead, follow the next step to ask CodeRabbit to implement part of its suggestions. 2. Post the following as another new comment:
135133

136134
<div class="custom-chat-bubble">
137135
<div class="chat-content">@coderabbitai generate docstrings</div>

‎docs/guides/custom-reports.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -327,17 +327,14 @@ Generate a weekly code review report for the author of this pull request only fo
327327
**Scoring Parameters:**
328328

329329
1. **Basic Code Standards (Score out of 2)**
330-
331330
- Avoidance of hard-coded values
332331
- No repetition of code (DRY principle)
333332

334333
2. **Code Readability (Score out of 2)**
335-
336334
- Presence of meaningful comments
337335
- Proper variable declaration using `const` and `let`
338336

339337
3. **Error Handling (Score out of 4)**
340-
341338
- Handling failure scenarios (e.g., try-catch, fallbacks)
342339
- Proper loading state implementation (e.g., button click loading states)
343340
- Handling edge cases (e.g., checking for undefined or missing values)
@@ -466,25 +463,21 @@ You will create a new chart averaging all the values from various pull requests
466463
## Best Practices
467464

468465
1. **Be Specific**
469-
470466
- Clearly define what should be included/excluded
471467
- Use precise language to avoid ambiguity
472468
- Specify exact metrics you want to track
473469

474470
2. **Structure Matters**
475-
476471
- Start with high-level summaries
477472
- Use consistent grouping patterns
478473
- Include clear section breaks
479474

480475
3. **Keep it Relevant**
481-
482476
- Focus on actionable information
483477
- Avoid redundant data points
484478
- Consider your audience's needs
485479

486480
4. **Optimize Readability**
487-
488481
- Use appropriate formatting
489482
- Include visual breaks
490483
- Maintain consistent styling

‎docs/guides/install-vscode.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ To install the CodeRabbit extension, follow these steps:
3131
1. Click **Install**.
3232

3333
1. A **Log in to CodeRabbit to get started** dialog appears. Click **Login**. If the dialog gets dismissed or times out first, then you can follow these alternate steps:
34-
3534
1. Click the CodeRabbit icon in the VSCode activity bar.
3635

3736
1. Click the **Use CodeRabbit for Free** button.
@@ -41,7 +40,6 @@ To install the CodeRabbit extension, follow these steps:
4140
1. In your web browser, log into your CodeRabbit account.
4241

4342
1. After signing in, the browser will redirect you back to VSCode. If the redirect does not occur, follow these steps:
44-
4543
1. Copy the code displayed in the success window.
4644

4745
2. Click **Paste code from browser**.

‎docs/guides/issue-chat.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -123,19 +123,16 @@ Example:
123123
## Best Practices
124124

125125
1. **Be Specific**
126-
127126
- Provide context in your questions
128127
- Mention specific files or features when relevant
129128
- Clarify your goals or requirements
130129

131130
2. **Iterative Refinement**
132-
133131
- Start with broad questions
134132
- Follow up for more details
135133
- Ask for clarification when needed
136134

137135
3. **Collaborative Planning**
138-
139136
- Include stakeholders in the conversation
140137
- Use issue chat to document decisions
141138
- Reference related issues or PRs

‎docs/guides/linked-issues.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ Create descriptive, technical titles that clearly state the goal:
4242
Write comprehensive descriptions that provide clear technical context:
4343

4444
1. **Problem Statement**
45-
4645
- Clearly describe what needs to be changed
4746
- Include technical details about affected components
4847
- Reference specific files or functions if known
@@ -144,19 +143,16 @@ Only the issue title and description are considered in the assessment. Comments
144143
## Tips for Better Assessments
145144

146145
1. **Be Specific**
147-
148146
- Include clear, measurable objectives
149147
- List specific technical requirements
150148
- Reference affected code components
151149

152150
2. **Provide Context**
153-
154151
- Explain why changes are needed
155152
- Document current behavior
156153
- Describe expected outcomes
157154

158155
3. **Use Technical Details**
159-
160156
- Include file paths when known
161157
- Reference specific functions or classes
162158
- Mention relevant technologies

‎docs/guides/reports-overview.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ You can track and analyze pull request activity across your organization's repos
1818
There are two ways to generate reports:
1919

2020
- **[Scheduled Reports](/guides/scheduled-reports)**: Set up automated, recurring reports that are delivered to your team on a set schedule. **Use this option if you want to adjust your settings and send a report more than once**. Supported delivery channels include the following:
21-
2221
- Email
2322
- Discord
2423
- Slack

‎docs/guides/roles.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -127,18 +127,18 @@ This sends an email to the address that you specified. After the recipient compl
127127
The following table lists the CodeRabbit administrative functionality
128128
available to each of the CodeRabbit roles.
129129

130-
| Resource | Admin | Member | Billing Admin |
131-
|----------|-------|---------|---------------|
132-
| Learning Resources | Read/Write | Read-only | No access |
133-
| Metrics/Dashboard | Read/Write | No access | No access |
134-
| Reports | Read/Write | Read-only | No access |
135-
| Integrations | Read/Write | Read-only | No access |
136-
| Repository Settings | Read/Write | Read-only | No access |
137-
| Organization Settings | Read/Write | Read-only | No access |
138-
| User Management | Read/Write | Read-only | Read-only |
139-
| Subscription Management | Read/Write | Read-only | Read/Write |
140-
| Billing Management | Read/Write | No access | Read/Write |
130+
| Resource | Admin | Member | Billing Admin |
131+
| ----------------------- | ---------- | --------- | ------------- |
132+
| Learning Resources | Read/Write | Read-only | No access |
133+
| Metrics/Dashboard | Read/Write | No access | No access |
134+
| Reports | Read/Write | Read-only | No access |
135+
| Integrations | Read/Write | Read-only | No access |
136+
| Repository Settings | Read/Write | Read-only | No access |
137+
| Organization Settings | Read/Write | Read-only | No access |
138+
| User Management | Read/Write | Read-only | Read-only |
139+
| Subscription Management | Read/Write | Read-only | Read/Write |
140+
| Billing Management | Read/Write | No access | Read/Write |
141141

142142
## What's next {#whats-next}
143143

144-
- [Manage your subscription](/getting-started/subscription-management)
144+
- [Manage your subscription](/getting-started/subscription-management)

‎docs/guides/scheduled-reports.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ The schedule configuration allows you to set precise timing for your reports:
2828
#### Frequency Options
2929

3030
- **Days of Week**
31-
3231
- Select any combination of days (Sun-Sat)
3332
- Set frequency (every 1-3 weeks)
3433
- Ideal for weekly team syncs or sprint reviews
@@ -232,12 +231,10 @@ Deleting a report will immediately stop all scheduled runs and remove access to
232231
## Best Practices
233232

234233
1. **Scheduling**
235-
236234
- Align report timing with your team's workflow
237235
- Consider timezone differences for distributed teams
238236

239237
2. **Content**
240-
241238
- Keep prompts focused on actionable information
242239
- Use grouping to improve readability
243240
- Exclude unnecessary details that may create noise

0 commit comments

Comments
 (0)