refactor(docs): reorganize navigation structure #155
Conversation
WalkthroughThis pull request introduces several updates across various documentation files for CodeRabbit, enhancing clarity and usability. Key changes include the addition of a new quickstart guide, modifications to existing documents for improved instruction clarity, and updates to metadata and sidebar configurations. Additionally, CSS styles have been enhanced for better visual presentation. The overall structure of the documentation remains intact, with a focus on providing clearer guidance for users regarding configuration and usage of CodeRabbit. Changes
Possibly related PRs
Suggested reviewers
Poem
🪧 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 (
|
Deploying coderabbit-docs with
|
| Latest commit: |
360ff41
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://51be9da5.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://docs-sidebar-restructure.coderabbit-docs.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (13)
docs/getting-started/quickstart.md (2)
24-24: Fix ordered list numbering format.The ordered list numbers should follow a consistent format. Currently, items 2 and 3 have incorrect prefixes.
-2. **Add Your Repository** +1. **Add Your Repository** -3. **You're Done 🎉** +1. **You're Done 🎉**Also applies to: 32-32
🧰 Tools
🪛 Markdownlint (0.35.0)
24-24: Expected: 1; Actual: 2; Style: 1/1/1
Ordered list item prefix(MD029, ol-prefix)
46-46: Consider using an official repository for the example PR.The current example PR links to a personal repository. Consider replacing it with an example from the CodeRabbit organization's repositories for better long-term maintenance and credibility.
docs/getting-started/configure-coderabbit.md (1)
Line range hint
1-24: Consider adding a reference to the quickstart guideSince a new quickstart guide has been added under the getting-started section, consider adding a reference to it at the beginning of this document for users who might prefer a simpler setup.
Add something like:
# At the beginning of the content + :::tip + Looking for a quick setup? Check out our [Quickstart Guide](./quickstart.md) for basic configuration. + ::: CodeRabbit offers various configuration options...docs/overview/introduction.md (2)
Line range hint
28-31: Optimize video iframe for better performance.Consider adding loading optimization attributes to improve page performance.
- <iframe src="https://www.youtube.com/embed/3SyUOSebG7E?si=i0oT9RAnH0PW81lY" title="YouTube video player" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerPolicy="strict-origin-when-cross-origin" allowFullScreen></iframe> + <iframe + src="https://www.youtube.com/embed/3SyUOSebG7E?si=i0oT9RAnH0PW81lY" + title="CodeRabbit Demo: AI-Powered Code Reviews" + loading="lazy" + frameBorder="0" + allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" + referrerPolicy="strict-origin-when-cross-origin" + allowFullScreen + ></iframe>
Line range hint
45-45: Enhance image accessibility.The image alt text could be more descriptive and SEO-friendly.
-  + docs/overview/why-coderabbit.md (3)
1-7: Enhance the meta description for better SEO.Consider expanding the description to be more specific about CodeRabbit's unique value proposition and benefits.
-description: CodeRabbit is AI-powered code reviews built for modern development teams +description: CodeRabbit delivers intelligent, context-aware code reviews powered by AI, helping modern development teams streamline their workflow, maintain code quality, and ship faster
138-142: Enhance the review time comparison example.The current comparison could be more informative with proper formatting and additional context.
-# Example review feedback time -Traditional Review: 24-48 hours -CodeRabbit Review: < 5 minutes +# Average Review Response Times +Traditional Code Review: 24-48 hours +CodeRabbit AI Review: < 5 minutes + +# Note: Actual times may vary based on PR complexity and team availability
160-163: Consider moving inline styles to a CSS file.For better maintainability and consistency across the documentation, consider moving the inline styles to a dedicated CSS file.
-<div style={{display: 'flex', gap: '10px', marginTop: '20px'}}> +<div className="cta-container"> <a href="https://app.coderabbit.ai/login" className="button button--primary button--lg">Sign Up Free</a> <a href="https://discord.gg/coderabbit" className="button button--secondary button--lg">Join Discord</a> </div>Then add to your CSS file:
.cta-container { display: flex; gap: 10px; margin-top: 20px; }src/css/custom.css (3)
222-225: Enhance active section indicator visibility and accessibilityConsider adding a more visible indicator for the active state and improving accessibility.
.navbar-link-active { font-weight: 600; position: relative; + /* Add visible indicator */ + &::after { + content: ''; + position: absolute; + bottom: -2px; + left: 0; + width: 100%; + height: 2px; + background-color: var(--ifm-color-primary); + } + /* Improve accessibility */ + &[aria-current="page"] { + border-bottom: 2px solid var(--ifm-color-primary); + } }
259-265: Use CSS variables for theme colorsConsider using CSS variables for icon colors to maintain consistency with the theme system.
[data-theme="light"] { + --icon-color: #424242; .discord-link::before { - background-image: url("data:image/svg+xml,%3Csvg ... fill='%23424242' ... + background-image: url("data:image/svg+xml,%3Csvg ... fill='var(--icon-color)' ... } .github-link::before { - background-image: url("data:image/svg+xml,%3Csvg ... fill='%23424242' ... + background-image: url("data:image/svg+xml,%3Csvg ... fill='var(--icon-color)' ... } } [data-theme="dark"] { + --icon-color: #fff; /* Update similar changes for dark mode */ }Also applies to: 278-284
205-209: Consider adding intermediate breakpointsThe current responsive design only handles mobile (<480px). Consider adding intermediate breakpoints for better tablet support.
@media screen and (max-width: 480px) { .github-link { margin: 0 0.25rem; } } + +/* Add tablet support */ +@media screen and (min-width: 481px) and (max-width: 768px) { + .github-link { + margin: 0 0.375rem; + } +}docs/guides/review-instructions.md (2)
Line range hint
1-24: Consider enhancing the introduction sectionThe introduction section could be improved by:
- Adding a brief overview of what CodeRabbit review instructions are
- Including a simple example to demonstrate the impact of custom review instructions
Consider adding content like this at the beginning:
The guide explains how to add custom review instructions for the entire project. + +Review instructions allow you to customize how CodeRabbit analyzes your code. For example: +```yaml +reviews: + path_instructions: + - path: "**/*.js" + instructions: | + Focus on identifying potential memory leaks and ensure proper error handling +```
Line range hint
234-235: Add links to supported language documentationIn the "Multiple Languages Support" section, consider adding links to the tree-sitter grammar documentation for each supported language. This would help users understand the available AST node types for pattern matching.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (11)
docs/about/_category_.ymlis excluded by!**/*.ymldocs/getting-started/_category_.ymlis excluded by!**/*.ymldocs/guides/_category_.ymlis excluded by!**/*.ymldocs/integrations/_category_.ymlis excluded by!**/*.ymldocs/overview/_category_.ymlis excluded by!**/*.ymldocs/platforms/_category_.yamlis excluded by!**/*.yamldocs/self-hosted/_category_.yamlis excluded by!**/*.yamldocs/tools/_category_.ymlis excluded by!**/*.ymlstatic/img/getting-started/coderabbit-dashboard.pngis excluded by!**/*.png,!**/*.pngstatic/img/getting-started/login-with-github.pngis excluded by!**/*.png,!**/*.pngstatic/img/getting-started/pr-example.pngis excluded by!**/*.png,!**/*.png
📒 Files selected for processing (9)
docs/getting-started/configure-coderabbit.md(1 hunks)docs/getting-started/quickstart.md(1 hunks)docs/guides/review-instructions.md(1 hunks)docs/overview/introduction.md(1 hunks)docs/overview/why-coderabbit.md(1 hunks)docusaurus.config.ts(3 hunks)sidebars.ts(0 hunks)src/css/custom.css(1 hunks)src/pages/markdown-page.md(0 hunks)
💤 Files with no reviewable changes (2)
- sidebars.ts
- src/pages/markdown-page.md
🧰 Additional context used
🪛 Markdownlint (0.35.0)
docs/getting-started/quickstart.md
24-24: Expected: 1; Actual: 2; Style: 1/1/1
Ordered list item prefix
(MD029, ol-prefix)
32-32: Expected: 1; Actual: 3; Style: 1/1/1
Ordered list item prefix
(MD029, ol-prefix)
🪛 LanguageTool
docs/overview/why-coderabbit.md
[typographical] ~47-~47: It appears that a comma is missing.
Context: ...ces - Documentation completeness :::tip Did you know? CodeRabbit's AI model is trai...
(COMMA_BEFORE_QUESTION_WITH_MD)
🔇 Additional comments (16)
docs/getting-started/quickstart.md (4)
1-6: LGTM! Well-structured frontmatter.
The metadata is complete and properly formatted, with a clear description and appropriate sidebar positioning.
10-12: Verify time estimation consistency.
The frontmatter mentions "2 minutes" while the note refers to "three simple steps". Consider aligning these messages for consistency.
-Get started with CodeRabbit in three simple steps. No complex configuration needed.
+Get started with CodeRabbit in less than 2 minutes with three simple steps. No complex configuration needed.16-36: LGTM! Clear and well-structured instructions.
The steps are logically organized and enhanced with relevant screenshots, making it easy for users to follow along.
🧰 Tools
🪛 Markdownlint (0.35.0)
24-24: Expected: 1; Actual: 2; Style: 1/1/1
Ordered list item prefix
(MD029, ol-prefix)
32-32: Expected: 1; Actual: 3; Style: 1/1/1
Ordered list item prefix
(MD029, ol-prefix)
51-59: LGTM! Comprehensive support information.
The help section provides multiple support channels and reinforces the key message about immediate functionality.
docs/getting-started/configure-coderabbit.md (2)
Line range hint 1-24: Well-structured content with clear hierarchy
The document maintains a logical flow with:
- Clear introduction of configuration options
- Explicit precedence order
- Interactive tools for validation
- Proper use of admonitions (tips, notes)
3-3: Verify navigation clarity with the shortened sidebar label
The sidebar label has been shortened from "Configure CodeRabbit" to "Configure". While this is more concise, please verify that it remains clear in the navigation context, especially for new users.
Let's check if there are other "Configure" labels that might cause confusion:
✅ Verification successful
Shortened sidebar label "Configure" is appropriate in context
The simplified label works well because:
- It's under the "getting-started" section with clear hierarchy (sidebar_position: 3)
- The page title still maintains full context as "Configure CodeRabbit"
- It's the only configuration-related document in the docs
- The description and content clearly indicate it's about CodeRabbit configuration
- There are no other "Configure" labels that could cause confusion
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Search for other configure-related labels in markdown files
# Expected: No other generic "Configure" labels that could cause confusion
rg -g "*.md" -g "*.mdx" "sidebar_label:.*[Cc]onfigure"
Length of output: 126
Script:
#!/bin/bash
# Let's check the structure of the documentation to understand the navigation context better
# First, let's find all sidebar labels in the getting-started section
rg -g "*.md" -g "*.mdx" "sidebar_label:" docs/getting-started/
# Then, let's also check if there's a sidebar configuration file that might provide more context
fd -e js -e json "sidebar" docs/
Length of output: 226
Script:
#!/bin/bash
# Let's check the actual content and structure of the getting-started section
# to see if the context makes it clear what's being configured
# First, check if there's a category/section label in the frontmatter
rg -g "*.md" -g "*.mdx" "^---$" -A 10 docs/getting-started/configure-coderabbit.md
# Also check if there are other configuration-related files in the docs
fd -e md -e mdx . docs/ | rg -i "config|configure"
Length of output: 766
docs/overview/introduction.md (3)
Line range hint 2-9: LGTM! Well-structured frontmatter metadata.
The metadata changes effectively support the documentation reorganization:
- Clear, descriptive title and labels
- Logical sidebar positioning
- Comprehensive description
- Appropriate root path slug
Line range hint 1-84: Well-structured documentation with clear navigation!
The changes effectively achieve the PR's objectives:
- Logical organization of content
- Clear and informative sections
- Proper use of markdown features and callouts
- Consistent tone and formatting
The suggested optimizations above are good-to-have improvements but don't block the approval of these changes.
Line range hint 82-84: Verify button styling consistency.
The button class names suggest custom styling. Let's verify the styling consistency across the documentation.
✅ Verification successful
Button styling appears consistent across documentation
The button styling is consistent across the documentation files:
- All buttons use the same class pattern:
button button--{variant} button--lg - Primary buttons are used for main CTAs (Sign Up, Start Review)
- Secondary button is used for supplementary action (Join Discord)
- All instances maintain the same structure and hierarchy
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check for consistent button styling across documentation
# Expected: Find all button class usage to ensure consistency
# Search for button class usage in markdown files
echo "Checking button class usage in markdown files:"
rg --type md "className=\"button" -A 1
# Search for button styles in CSS files
echo -e "\nChecking button styles in CSS files:"
fd -e css -x rg "\.button"
Length of output: 775
Script:
#!/bin/bash
# Let's check for button styling in the theme CSS files which are common in documentation sites
echo "Checking for button styles in theme or custom CSS files:"
fd -e css -e scss "custom|theme|button" -x rg "\.button|button--|button-"
# Also check for any potential button styling in JavaScript/TypeScript files that might contain CSS-in-JS
echo -e "\nChecking for button styles in JS/TS files:"
fd -e js -e jsx -e ts -e tsx -x rg "\.button|button--|button-"
# Let's also check if there are any other similar button elements in MDX/MD files
echo -e "\nChecking for similar button patterns in MD/MDX files:"
rg --type md "button--(primary|secondary|lg)"
Length of output: 960
docusaurus.config.ts (3)
106-106: LGTM! Explicit path configuration improves clarity.
The addition of explicit path configuration is a good practice, making the documentation structure more maintainable.
169-173: LGTM! Improved logo accessibility.
The addition of proper alt text and target attribute for the logo improves accessibility and user experience.
45-45: Verify complete redirect coverage for reorganized content.
The redirects have been updated to point to the new "/getting-started/configure-coderabbit" path, which aligns with the documentation reorganization. However, let's ensure we haven't missed any old paths that need redirecting.
Also applies to: 49-49, 57-57
✅ Verification successful
Redirect configuration is properly implemented
Based on the verification results:
- No references to old paths (
/get-started,/guides/customize-coderabbit,/guides/configure-coderabbit) were found in any markdown files - The new target page
/getting-started/configure-coderabbitexists and contains comprehensive configuration documentation - All internal links in the documentation have been properly updated to use the new structure
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for any remaining references to old paths in markdown files
echo "Searching for potential missing redirects..."
rg -l "(/get-started|/guides/customize-coderabbit|/guides/configure-coderabbit)" --type md
# Check if there are any broken internal links
echo "Checking for broken internal links..."
rg -l "\]\(/(?!getting-started/configure-coderabbit|platforms/|guides/review-instructions)" --type md
Length of output: 672
Script:
#!/bin/bash
# Search for any remaining references to old paths in markdown files
echo "Searching for potential missing redirects..."
rg "(/get-started|/guides/customize-coderabbit|/guides/configure-coderabbit)" --type md
# Check for internal links with a simpler pattern
echo "Checking internal links..."
fd -e md -x rg -l "\]\(/" {} \;
# List all markdown files in docs directory for reference
echo "Listing markdown files in docs..."
fd -e md . docs/
Length of output: 2045
Script:
#!/bin/bash
# Check content of files that have internal links for any outdated paths
echo "Checking content of files with internal links..."
for file in docs/overview/introduction.md docs/faq.md docs/getting-started/quickstart.md docs/about/{support,pricing,features}.md docs/guides/{review-instructions,ondemand-reports,delete-account}.md; do
echo "=== $file ==="
rg "\]\(/(?:get-started|guides/customize-coderabbit|guides/configure-coderabbit)" "$file" || true
done
# Check the new configure-coderabbit page exists and has content
echo "Verifying new configuration page..."
cat docs/getting-started/configure-coderabbit.md
Length of output: 5767
docs/overview/why-coderabbit.md (1)
1-163: Well-structured documentation with clear value proposition!
The document effectively communicates CodeRabbit's benefits and features while maintaining a logical flow. The content aligns well with the PR objectives of reorganizing the documentation structure.
🧰 Tools
🪛 LanguageTool
[typographical] ~47-~47: It appears that a comma is missing.
Context: ...ces - Documentation completeness :::tip Did you know? CodeRabbit's AI model is trai...
(COMMA_BEFORE_QUESTION_WITH_MD)
src/css/custom.css (2)
174-197: Well-implemented GitHub icon styling!
Clean implementation using SVG data URL with proper hover effects and transitions.
172-285: Overall excellent implementation of navigation styles!
The CSS implementation is clean, well-organized, and properly handles both light and dark themes. The suggested improvements are minor enhancements to an already solid foundation.
docs/guides/review-instructions.md (1)
12-12: Verify the new documentation path
The link has been updated to use an absolute path /getting-started/configure-coderabbit. This aligns with the PR's reorganization of content into logical categories.
Let's verify if this new path exists in the repository:
✅ Verification successful
Link path is correct and properly referenced
The absolute path /getting-started/configure-coderabbit is valid as verified by:
- The target file exists at
docs/getting-started/configure-coderabbit.md - The path is consistently referenced in other documentation files including the quickstart guide
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the existence of the linked documentation file
# and check for any other references to this path
# Check if the target file exists
fd -t f "configure-coderabbit.md" docs/getting-started/
# Check for other references to this path
rg -l "configure-coderabbit" docs/
Length of output: 205
docusaurus.config.ts
Outdated
| items: [ | ||
| // Direct links to main sections | ||
| { | ||
| label: "Docs", | ||
| position: "left", | ||
| to: "/", // Root of documentation | ||
| className: "navbar-link-active", // Highlight current section | ||
| }, | ||
| { | ||
| href: "https://api.coderabbit.ai/api/swagger/", | ||
| label: "API Reference", | ||
| position: "left", | ||
| }, | ||
| { | ||
| href: "https://blog.coderabbit.ai/blog", | ||
| label: "Blog", | ||
| position: "left", | ||
| }, | ||
| { | ||
| href: "https://discord.gg/coderabbit", | ||
| className: "navbar-icon-link discord-link", | ||
| "aria-label": "Discord", | ||
| position: "right", | ||
| }, | ||
| { | ||
| href: "https://github.com/coderabbitai", | ||
| className: "github-link", | ||
| "aria-label": "GitHub", | ||
| position: "right", | ||
| }, | ||
| ], |
There was a problem hiding this comment.
💡 Codebase verification
CSS classes are properly defined, but external link security can be improved
All mentioned CSS classes (navbar-link-active, navbar-icon-link, discord-link, github-link) are properly defined in src/css/custom.css with appropriate styling, including hover states and theme-specific variations.
Consider adding the suggested security attributes to external links:
- Add
rel="noopener noreferrer"andtarget="_blank"to:- Discord link (
https://discord.gg/coderabbit) - GitHub link (
https://github.com/coderabbitai) - API Reference link (
https://api.coderabbit.ai/api/swagger/) - Blog link (
https://blog.coderabbit.ai/blog)
- Discord link (
🔗 Analysis chain
Verify CSS classes and enhance external link security.
While the navbar structure is well-organized, there are two areas to address:
- Custom CSS classes are used (
navbar-link-active,navbar-icon-link,discord-link,github-link). Let's verify these exist. - External links should include security attributes.
Consider adding security-related attributes to external links:
{
href: "https://discord.gg/coderabbit",
className: "navbar-icon-link discord-link",
"aria-label": "Discord",
position: "right",
+ rel: "noopener noreferrer",
+ target: "_blank",
},Apply similar changes to other external links (API Reference, Blog, GitHub) to prevent potential security vulnerabilities like reverse tabnabbing.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the custom CSS classes are defined
echo "Checking for CSS class definitions..."
rg -l "(navbar-link-active|navbar-icon-link|discord-link|github-link)" --type css
Length of output: 187
Script:
#!/bin/bash
# Let's check the actual CSS definitions to ensure they are properly defined
echo "Checking CSS definitions in src/css/custom.css..."
rg "(navbar-link-active|navbar-icon-link|discord-link|github-link)" src/css/custom.css -A 2
Length of output: 5721
|
|
||
| ## Real-World Code Reviews | ||
|
|
||
| > CodeRabbit currently processes [Over 470,000 pull requests](https://github.com/search?q=coderabbitai&type=pullrequests) have been reviewed by CodeRabbit across multiple languages including TypeScript, Go, Python, JavaScript, Java, Rust, C#, and PHP. |
There was a problem hiding this comment.
Fix grammatical structure in statistics statement.
The current sentence combines two different statements incorrectly.
-CodeRabbit currently processes [Over 470,000 pull requests](https://github.com/search?q=coderabbitai&type=pullrequests) have been reviewed by CodeRabbit across multiple languages including TypeScript, Go, Python, JavaScript, Java, Rust, C#, and PHP.
+Over [470,000 pull requests](https://github.com/search?q=coderabbitai&type=pullrequests) have been reviewed by CodeRabbit across multiple languages including TypeScript, Go, Python, JavaScript, Java, Rust, C#, and PHP.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| > CodeRabbit currently processes [Over 470,000 pull requests](https://github.com/search?q=coderabbitai&type=pullrequests) have been reviewed by CodeRabbit across multiple languages including TypeScript, Go, Python, JavaScript, Java, Rust, C#, and PHP. | |
| > Over [470,000 pull requests](https://github.com/search?q=coderabbitai&type=pullrequests) have been reviewed by CodeRabbit across multiple languages including TypeScript, Go, Python, JavaScript, Java, Rust, C#, and PHP. |
- Move content under logical categories (about, getting-started, guides) - Fix redirect paths and config for new structure - Update sidebars.ts to match folder hierarchy - Add quickstart guide under getting-started Signed-off-by: Ankur Tyagi <[email protected]>
- Improve navigation hierarchy and structure - Update sidebar styling - Implement collapsible sections - Add hover states and active indicators
tyaga001
force-pushed
the
docs/sidebar-restructure
branch
from
f7ff5d4
to
2604881
Compare
[dependabot skip]
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Outside diff range and nitpick comments (13)
docs/getting-started/quickstart.md (3)
1-6: Consider a more professional titleThe current title "Playing with CodeRabbit" might not convey the professional nature of the tool. Consider alternatives like:
- "Getting Started with CodeRabbit"
- "CodeRabbit Quick Setup"
- "Setting up CodeRabbit"
-title: Playing with CodeRabbit +title: Getting Started with CodeRabbit
14-37: Fix formatting issues in the steps section
- Add missing period at the end of line 36
- Ensure consistent ordered list item prefixes (Markdownlint MD029)
-No additional setup needed +No additional setup needed.🧰 Tools
🪛 Markdownlint (0.35.0)
24-24: Expected: 1; Actual: 2; Style: 1/1/1
Ordered list item prefix(MD029, ol-prefix)
32-32: Expected: 1; Actual: 3; Style: 1/1/1
Ordered list item prefix(MD029, ol-prefix)
🪛 LanguageTool
[uncategorized] ~36-~36: A period might be missing here.
Context: ...ks out of the box - No additional setup needed ## What's Next? - Watch CodeRabbit re...(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
46-46: Consider using an official repository for the example PRThe example PR link points to a personal repository (
tyaga001/devtoolsacademy). Consider using an example from the official CodeRabbit repository for better credibility and longevity.docs/overview/introduction.md (2)
Line range hint
31-33: Enhance iframe security attributesWhile the iframe includes security attributes, consider adding additional security measures.
- <iframe src="https://www.youtube.com/embed/3SyUOSebG7E?si=i0oT9RAnH0PW81lY" title="YouTube video player" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerPolicy="strict-origin-when-cross-origin" allowFullScreen></iframe> + <iframe + src="https://www.youtube.com/embed/3SyUOSebG7E?si=i0oT9RAnH0PW81lY" + title="CodeRabbit Demo Video" + frameBorder="0" + allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" + referrerPolicy="strict-origin-when-cross-origin" + loading="lazy" + sandbox="allow-scripts allow-same-origin allow-presentation" + allowFullScreen + ></iframe>
Image path needs to be updated to match the actual location
The image exists at
static/img/about/coderabbit-flow.pngbut is referenced as/img/about/coderabbit-flow.png. Please update the image path in the markdown file to use the correct path that includesstatic/prefix.🔗 Analysis chain
Line range hint
47-47: Verify image path after reorganizationLet's ensure the image path is still valid after the documentation reorganization.
Let me check the actual image reference in the file to verify if it matches the found location.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify image path existence # Check if the image exists in the new structure echo "Checking for image existence..." fd "coderabbit-flow.png" public/img/ static/img/ || echo "Image not found in expected directories"Length of output: 216
Script:
#!/bin/bash # Check the actual image reference in the file rg -U "!\[.*\].*coderabbit-flow\.png" docs/overview/introduction.mdLength of output: 249
docs/overview/why-coderabbit.md (2)
140-141: Standardize time format in comparison.For better readability, use consistent time format in the comparison.
-Traditional Review: 24-48 hours -CodeRabbit Review: < 5 minutes +Traditional Review: 24-48 hours +CodeRabbit Review: <5 minutes
160-163: Consider moving inline styles to CSS file.For better maintainability and consistency, consider moving the inline styles to a dedicated CSS file.
-<div style={{display: 'flex', gap: '10px', marginTop: '20px'}}> +<div className="cta-button-container"> <a href="https://app.coderabbit.ai/login" className="button button--primary button--lg">Sign Up Free</a> <a href="https://discord.gg/coderabbit" className="button button--secondary button--lg">Join Discord</a> </div>Add to your CSS file:
.cta-button-container { display: flex; gap: 10px; margin-top: 20px; }docs/faq.md (2)
107-107: Consider consolidating review instructions references.The review instructions are referenced in both "Customization Options" and "Interaction Guide" sections. Consider consolidating these references to avoid redundancy and potential confusion.
- 4. Customize via [Review Instructions](/guides/review-instructions) + 4. Use custom review commands
143-215: Well-structured account deletion documentation with minor improvements needed.The account deletion documentation is comprehensive and well-organized. Consider these enhancements:
- The platform-specific cleanup steps are necessary to completely remove CodeRabbit access. + The platform-specific cleanup steps are required to permanently revoke CodeRabbit access.Also, consider adding estimated time requirements for the cleanup process to set proper user expectations.
🧰 Tools
🪛 LanguageTool
[style] ~211-~211: Consider using a different verb to strengthen your wording.
Context: ...eanup steps are necessary to completely remove CodeRabbit access. Without completing t...(REMOVE_REVOKE)
src/css/custom.css (4)
174-197: Enhance accessibility and maintainability of GitHub iconConsider these improvements:
- Add aria-label for screen readers
- Use CSS custom properties for consistent sizing
.github-link:before { content: ""; - width: 24px; - height: 24px; + width: var(--icon-size, 24px); + height: var(--icon-size, 24px); display: flex; background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='currentColor' d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") no-repeat; } .github-link { - width: 24px; - height: 24px; + width: var(--icon-size, 24px); + height: var(--icon-size, 24px); display: flex; align-items: center; justify-content: center; margin: 0 0.5rem; opacity: 0.7; transition: opacity 0.2s; + aria-label: "GitHub Repository"; }
222-225: Enhance visibility of active section indicatorThe current active section indicator only uses font-weight, which might not be sufficient for all users. Consider adding a subtle visual indicator.
.navbar-link-active { font-weight: 600; position: relative; + &::after { + content: ''; + position: absolute; + bottom: -2px; + left: 0; + width: 100%; + height: 2px; + background-color: var(--ifm-color-primary); + transform: scaleX(0.8); + transition: transform 0.2s ease; + } }
250-285: Optimize SVG handling for theme modesConsider using CSS custom properties for SVG URLs to reduce duplication and improve maintainability.
+:root { + --discord-icon-light: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 127.14 96.36' fill='%23424242'%3E...%3C/svg%3E"); + --discord-icon-dark: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 127.14 96.36' fill='%23fff'%3E...%3C/svg%3E"); + --github-icon-light: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg' fill='%23424242'%3E...%3C/svg%3E"); + --github-icon-dark: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg' fill='%23fff'%3E...%3C/svg%3E"); +} [data-theme="light"] { .discord-link::before { - background-image: url("data:image/svg+xml,..."); + background-image: var(--discord-icon-light); } .github-link::before { - background-image: url("data:image/svg+xml,..."); + background-image: var(--github-icon-light); } } [data-theme="dark"] { .discord-link::before { - background-image: url("data:image/svg+xml,..."); + background-image: var(--discord-icon-dark); } .github-link::before { - background-image: url("data:image/svg+xml,..."); + background-image: var(--github-icon-dark); } }
205-209: Use CSS custom properties for breakpointsConsider defining breakpoints as CSS custom properties for better maintainability and consistency.
+:root { + --breakpoint-mobile: 480px; + --breakpoint-tablet: 768px; +} -@media screen and (max-width: 480px) { +@media screen and (max-width: var(--breakpoint-mobile)) { .github-link { margin: 0 0.25rem; } }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (13)
docs/about/_category_.ymlis excluded by!**/*.ymldocs/getting-started/_category_.ymlis excluded by!**/*.ymldocs/guides/_category_.ymlis excluded by!**/*.ymldocs/integrations/_category_.ymlis excluded by!**/*.ymldocs/overview/_category_.ymlis excluded by!**/*.ymldocs/platforms/_category_.yamlis excluded by!**/*.yamldocs/self-hosted/_category_.yamlis excluded by!**/*.yamldocs/tools/_category_.ymlis excluded by!**/*.ymlstatic/img/getting-started/coderabbit-dashboard.pngis excluded by!**/*.png,!**/*.pngstatic/img/getting-started/dashboard-coderabbit.pngis excluded by!**/*.png,!**/*.pngstatic/img/getting-started/login-with-github.pngis excluded by!**/*.png,!**/*.pngstatic/img/getting-started/pr-example.pngis excluded by!**/*.png,!**/*.pngstatic/img/getting-started/pr-examples.pngis excluded by!**/*.png,!**/*.png
📒 Files selected for processing (13)
docs/about/pricing.md(1 hunks)docs/about/support.md(1 hunks)docs/faq.md(3 hunks)docs/getting-started/configure-coderabbit.md(1 hunks)docs/getting-started/quickstart.md(1 hunks)docs/guides/delete-account.md(0 hunks)docs/guides/review-instructions.md(1 hunks)docs/overview/introduction.md(1 hunks)docs/overview/why-coderabbit.md(1 hunks)docusaurus.config.ts(3 hunks)sidebars.ts(0 hunks)src/css/custom.css(1 hunks)src/pages/markdown-page.md(0 hunks)
💤 Files with no reviewable changes (3)
- docs/guides/delete-account.md
- sidebars.ts
- src/pages/markdown-page.md
🚧 Files skipped from review as they are similar to previous changes (3)
- docs/getting-started/configure-coderabbit.md
- docs/guides/review-instructions.md
- docusaurus.config.ts
🧰 Additional context used
🪛 LanguageTool
docs/faq.md
[style] ~211-~211: Consider using a different verb to strengthen your wording.
Context: ...eanup steps are necessary to completely remove CodeRabbit access. Without completing t...
(REMOVE_REVOKE)
docs/getting-started/quickstart.md
[uncategorized] ~36-~36: A period might be missing here.
Context: ...ks out of the box - No additional setup needed ## What's Next? - Watch CodeRabbit re...
(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
docs/overview/why-coderabbit.md
[typographical] ~47-~47: It appears that a comma is missing.
Context: ...ces - Documentation completeness :::tip Did you know? CodeRabbit's AI model is trai...
(COMMA_BEFORE_QUESTION_WITH_MD)
[uncategorized] ~158-~158: Possible missing comma found.
Context: ...ter signing up, join our active Discord community where you'll find CodeRabbit users and ...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 Markdownlint (0.35.0)
docs/getting-started/quickstart.md
24-24: Expected: 1; Actual: 2; Style: 1/1/1
Ordered list item prefix
(MD029, ol-prefix)
32-32: Expected: 1; Actual: 3; Style: 1/1/1
Ordered list item prefix
(MD029, ol-prefix)
🔇 Additional comments (12)
docs/getting-started/quickstart.md (3)
8-12: LGTM!
The introduction effectively sets user expectations and emphasizes the simplicity of the setup process.
51-59: LGTM!
The help section provides comprehensive support options and ends with a reassuring tip about immediate functionality.
48-49: Verify internal documentation links
Let's verify that the referenced documentation pages exist.
✅ Verification successful
Internal documentation links are valid
Both referenced documentation pages exist in the repository:
/docs/getting-started/configure-coderabbit.md/docs/guides/review-instructions.md
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check if the referenced documentation files exist
# Expected: All files should be present
fd -t f "configure-coderabbit.md" docs/getting-started/
fd -t f "review-instructions.md" docs/guides/
Length of output: 181
docs/overview/introduction.md (2)
Line range hint 77-79: Verify login URL functionality
The call-to-action button links to the login page. Let's verify this URL is correct and consistent across the documentation.
✅ Verification successful
Login URL is consistently used across documentation
The login URL https://app.coderabbit.ai/login is used consistently throughout the documentation files, including:
- Call-to-action buttons in introduction and why-coderabbit pages
- Platform configuration pages (GitHub.com, GitHub Enterprise, Self-hosted GitLab)
- Support documentation
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check for consistency in login URL usage
echo "Checking login URL consistency..."
rg "app.coderabbit.ai/login" --type md
Length of output: 1346
Line range hint 2-9: Verify navigation structure alignment
The metadata changes look good and align with making this the landing page. However, let's verify the navigation structure consistency.
✅ Verification successful
Navigation structure needs adjustment
Multiple sections have files with sidebar_position: 1, which is expected as they represent the first page in their respective sections. However, the root landing page (/) should be unique. The current structure shows:
docs/overview/introduction.mdis correctly placed in the overview section- Multiple top-level sections exist: about, getting-started, guides, integrations, overview, platforms, self-hosted, tools
- Each section appears to maintain its own navigation hierarchy
Navigation structure is correctly organized
The changes to introduction.md are well-structured and don't create any conflicts:
- No other files are using the root slug "/"
- While multiple sections have
sidebar_position: 1, this is correct as they represent the first page in their respective sections - No other files are titled "Introduction"
- The file is appropriately placed in the
docs/overview/section
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify navigation structure consistency
# Check for other files with slug "/" and sidebar_position: 1
# to ensure no conflicts in the navigation
echo "Checking for potential navigation conflicts..."
rg -l "slug: \"/\"" --type md | grep -v "introduction.md" || echo "No conflicting root slugs found"
rg -B2 "sidebar_position: 1" --type md | grep -v "introduction.md" || echo "No conflicting sidebar positions found"
# Check if this fits in the expected folder structure
echo "Verifying folder structure..."
fd . -t d -d 1 docs/
Length of output: 1565
Script:
#!/bin/bash
# Let's verify if there's a docusaurus config file that defines the navigation structure
fd -e js -e json "docusaurus.config"
# Also check if there are any other index/introduction files that might conflict
rg -l "^title: Introduction" --type md | grep -v "docs/overview/introduction.md" || echo "No other introduction files found"
Length of output: 194
docs/about/pricing.md (1)
Line range hint 1-103: LGTM! Well-structured documentation
The document is well-organized with clear sections for each plan, consistent pricing information, and helpful subscription management details including dark/light mode images.
Also applies to: 117-150
docs/overview/why-coderabbit.md (3)
1-7: LGTM!
The frontmatter is well-structured with all necessary fields properly configured.
19-19:
Fix grammatical structure in statistics statement.
The sentence incorrectly combines two different statements.
-CodeRabbit currently processes [Over 470,000 pull requests](https://github.com/search?q=coderabbitai&type=pullrequests) have been reviewed by CodeRabbit across multiple languages including TypeScript, Go, Python, JavaScript, Java, Rust, C#, and PHP.
+Over [470,000 pull requests](https://github.com/search?q=coderabbitai&type=pullrequests) have been reviewed by CodeRabbit across multiple languages including TypeScript, Go, Python, JavaScript, Java, Rust, C#, and PHP.81-85: Verify platform and language support claims.
Let's verify that all listed platforms and languages are officially supported.
✅ Verification successful
Based on the search results, I can verify that the documentation accurately reflects the supported platforms and languages. Let me break down the findings:
Platform support verification confirmed
The documentation correctly lists GitHub, GitLab, and Azure DevOps as supported platforms. This is evidenced by:
- Dedicated platform documentation for each service
- Integration guides for both cloud and self-hosted versions
- Active changelog entries showing ongoing support and features
- Multiple references throughout the documentation confirming integration capabilities
Language support verification confirmed
The documentation's claim about supporting "all major programming languages" is accurate, with evidence showing:
- Built-in support for major languages including TypeScript, Go, Python, JavaScript, Java, Rust, C#, and PHP
- Language-specific linting tools integration (e.g., golangci-lint for Go, PHPStan for PHP, etc.)
- Dedicated language-specific configuration options and tooling
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify supported platforms and languages in documentation
# Check documentation and configuration files for platform support
echo "Checking platform support..."
rg -i "github|gitlab|azure" docs/
rg -i "supported.*platforms?" docs/
# Check documentation and configuration files for language support
echo "Checking language support..."
rg -i "typescript|go|python|javascript|java|rust|c#|php" docs/
rg -i "supported.*languages?" docs/
Length of output: 41313
docs/faq.md (3)
83-83: LGTM! Clear and helpful tip for users.
The tip effectively explains how to trigger reviews for PRs created before CodeRabbit installation.
91-91: Verify the review instructions page exists in the new structure.
The link to /guides/review-instructions should be validated as part of the documentation reorganization.
✅ Verification successful
Link to review instructions is valid
The referenced page /guides/review-instructions exists at the correct location docs/guides/review-instructions.md in the new documentation structure.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the referenced guide exists in the new structure
fd "review-instructions.md" docs/guides
Length of output: 74
140-140: Verify support page location and Discord link validity.
Please ensure:
- The
/about/supportpage exists in the new navigation structure - The Discord invite link is permanent and valid
✅ Verification successful
Support page and Discord link are valid and properly integrated
The verification confirms:
- The support page exists at
docs/about/support.mdwith proper content and metadata - The Discord link (http://discord.gg/coderabbit) is correctly formatted and referenced consistently in both the FAQ and support page
- The support page is properly cross-referenced in the documentation
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the support page exists in the new structure
fd "support.md" docs/about
# Validate Discord invite link format
if ! echo "http://discord.gg/coderabbit" | grep -E '^https?://discord\.gg/[a-zA-Z0-9]+$'; then
echo "Warning: Discord invite link format might not be optimal. Consider using a permanent invite link."
fi
Length of output: 161
Script:
#!/bin/bash
# Let's verify the content of support.md to ensure it's a valid page
cat docs/about/support.md
# Also check if there are any other references to this support page
rg -l "/about/support"
Length of output: 2421
| - Click "Sign in with GitHub" | ||
| - Authorize CodeRabbit | ||
|
|
||
|  |
There was a problem hiding this comment.
💡 Codebase verification
Image paths need to be updated with correct prefix
The referenced images exist in the repository but the paths in the markdown file are incorrect. All images are located under the static/ directory, but the markdown references them without this prefix. Update the image paths to include static prefix:
- Update
/img/integrations/login-self-hosted-github.pngto/static/img/integrations/login-self-hosted-github.png - Update
/img/getting-started/dashboard-coderabbit.pngto/static/img/getting-started/dashboard-coderabbit.png - Update
/img/getting-started/pr-examples.pngto/static/img/getting-started/pr-examples.png
🔗 Analysis chain
Verify image paths and ensure images exist
Let's verify that the referenced images exist in the repository.
Also applies to: 30-30, 44-44
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check if the referenced images exist in the repository
# Expected: All images should be present
fd -t f "login-self-hosted-github.png" img/integrations/
fd -t f "dashboard-coderabbit.png" img/getting-started/
fd -t f "pr-examples.png" img/getting-started/
Length of output: 480
Script:
#!/bin/bash
# Let's first check if the image directories exist and their actual location
fd -t d "img"
# Then search for the image files across the repository
fd -t f "login-self-hosted-github.png"
fd -t f "dashboard-coderabbit.png"
fd -t f "pr-examples.png"
Length of output: 273
There was a problem hiding this comment.
@coderabbitai we've mentioned this in last couple of PRs that this is the correct path and you've added in your learnings? don't repeat this mistake again.
There was a problem hiding this comment.
@tyaga001, I apologize for the oversight. I will ensure that future reviews reflect the correct image paths as you've mentioned. Thank you for your patience.
✏️ Learnings added
Learnt from: tyaga001
PR: coderabbitai/coderabbit-docs#155
File: docs/getting-started/quickstart.md:22-22
Timestamp: 2024-11-28T16:45:07.897Z
Learning: In the `coderabbitai/coderabbit-docs` repository, when reviewing markdown files, image paths that start with `/img/` are correct and should not include the `static` prefix, even though the images are located in the `static/` directory.
Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.
| @@ -44,7 +44,7 @@ Regardless of the method or location through which CodeRabbit provides Support, | |||
| :::tip | |||
|
|
|||
| To see more common issues faced by CodeRabbit users, visit our | |||
| [FAQ section](../faq.md) for detailed answers and solutions to frequently | |||
| [FAQ section](/faq)) for detailed answers and solutions to frequently | |||
There was a problem hiding this comment.
Fix the Markdown link syntax error
The line contains an extra closing parenthesis that would break the link rendering.
Apply this diff to fix the syntax:
-[FAQ section](/faq)) for detailed answers and solutions to frequently
+[FAQ section](/faq) for detailed answers and solutions to frequentlyThe change to use an absolute path (/faq) is a good practice for documentation links.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| [FAQ section](/faq)) for detailed answers and solutions to frequently | |
| [FAQ section](/faq) for detailed answers and solutions to frequently |
| | Feature | Free Plan | Pro Plan | Lite Plan | | ||
| | ------------------------------ | ----------------- | ----------------- | ---------------- | | ||
| | **Free Trial** | 14-day free trial | 14-day free trial | No | | ||
| | **Private Repos** | Limited access | Unlimited access | Limited access | | ||
| | **Public Repos** | Unlimited access | Unlimited access | Unlimited access | | ||
| | **Pull Request Summarization** | Included | Included | Included | | ||
| | **Line-by-Line Reviews** | Public repos only | All repos | All repos | | ||
| | **Conversational Bot** | No | Yes | Yes | | ||
| | **Linters and SAST tools** | No | No | Yes | | ||
| | **Jira & Linear Integration** | No | No | Yes | | ||
| | **ROI dashboards** | No | No | Yes | | ||
| | **Customizable reports** | No | No | Yes | | ||
| | **Price** | Free forever | $15 per seat/mo | $30 per seat/mo | |
There was a problem hiding this comment.
Critical inconsistencies in the Plan Comparison table
The table contains several inconsistencies with the detailed plan descriptions above:
- The Lite Plan is incorrectly shown as having no free trial, while its detailed description states "begins with a 14-day free trial"
- Advanced features (Linters, Jira integration, ROI dashboards, and reports) are incorrectly attributed to the Lite Plan instead of the Pro Plan
- The column ordering (Free -> Pro -> Lite) differs from the document's structure where Lite is presented before Pro
Here's the corrected table structure:
-| Feature | Free Plan | Pro Plan | Lite Plan |
-| ------------------------------ | ----------------- | ----------------- | ---------------- |
-| **Free Trial** | 14-day free trial | 14-day free trial | No |
-| **Private Repos** | Limited access | Unlimited access | Limited access |
-| **Public Repos** | Unlimited access | Unlimited access | Unlimited access |
-| **Pull Request Summarization** | Included | Included | Included |
-| **Line-by-Line Reviews** | Public repos only | All repos | All repos |
-| **Conversational Bot** | No | Yes | Yes |
-| **Linters and SAST tools** | No | No | Yes |
-| **Jira & Linear Integration** | No | No | Yes |
-| **ROI dashboards** | No | No | Yes |
-| **Customizable reports** | No | No | Yes |
-| **Price** | Free forever | $15 per seat/mo | $30 per seat/mo |
+| Feature | Free Plan | Lite Plan | Pro Plan |
+| ------------------------------ | ----------------- | ----------------- | ---------------- |
+| **Free Trial** | 14-day free trial | 14-day free trial | 14-day free trial|
+| **Private Repos** | Limited access | Unlimited access | Unlimited access |
+| **Public Repos** | Unlimited access | Unlimited access | Unlimited access |
+| **Pull Request Summarization** | Included | Included | Included |
+| **Line-by-Line Reviews** | Public repos only | All repos | All repos |
+| **Conversational Bot** | No | Yes | Yes |
+| **Linters and SAST tools** | No | No | Yes |
+| **Jira & Linear Integration** | No | No | Yes |
+| **ROI dashboards** | No | No | Yes |
+| **Customizable reports** | No | No | Yes |
+| **Price** | Free forever | $15 per seat/mo | $30 per seat/mo |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | Feature | Free Plan | Pro Plan | Lite Plan | | |
| | ------------------------------ | ----------------- | ----------------- | ---------------- | | |
| | **Free Trial** | 14-day free trial | 14-day free trial | No | | |
| | **Private Repos** | Limited access | Unlimited access | Limited access | | |
| | **Public Repos** | Unlimited access | Unlimited access | Unlimited access | | |
| | **Pull Request Summarization** | Included | Included | Included | | |
| | **Line-by-Line Reviews** | Public repos only | All repos | All repos | | |
| | **Conversational Bot** | No | Yes | Yes | | |
| | **Linters and SAST tools** | No | No | Yes | | |
| | **Jira & Linear Integration** | No | No | Yes | | |
| | **ROI dashboards** | No | No | Yes | | |
| | **Customizable reports** | No | No | Yes | | |
| | **Price** | Free forever | $15 per seat/mo | $30 per seat/mo | | |
| | Feature | Free Plan | Lite Plan | Pro Plan | | |
| | ------------------------------ | ----------------- | ----------------- | ---------------- | | |
| | **Free Trial** | 14-day free trial | 14-day free trial | 14-day free trial| | |
| | **Private Repos** | Limited access | Unlimited access | Unlimited access | | |
| | **Public Repos** | Unlimited access | Unlimited access | Unlimited access | | |
| | **Pull Request Summarization** | Included | Included | Included | | |
| | **Line-by-Line Reviews** | Public repos only | All repos | All repos | | |
| | **Conversational Bot** | No | Yes | Yes | | |
| | **Linters and SAST tools** | No | No | Yes | | |
| | **Jira & Linear Integration** | No | No | Yes | | |
| | **ROI dashboards** | No | No | Yes | | |
| | **Customizable reports** | No | No | Yes | | |
| | **Price** | Free forever | $15 per seat/mo | $30 per seat/mo | |
new docs look -
old docs look -