doc fixes #33
Merged
doc fixes #33
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughWalkthroughThis update enhances the clarity, accuracy, and organization of the CodeRabbit documentation across various sections, including features, pricing, support, FAQs, and guides. It introduces new information, updates existing content for relevance, and shifts the focus from customization to configuration, aiming to improve user understanding and interaction with CodeRabbit. The changes are designed to address user needs more effectively and streamline the documentation structure. Changes
Related issues
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
✅ Deploy Preview for reliable-buttercream-0e11cf ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Deploying coderabbit-docs with
|
| Latest commit: |
9b0656f
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://5ebe89a8.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://docs-fixes.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.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files ignored due to path filters (2)
docs/faq/images/cr_support_orgs_dark.pngis excluded by:!**/*.pngdocs/faq/images/cr_support_orgs_light.pngis excluded by:!**/*.png
Files selected for processing (5)
- docs/about/features.md (3 hunks)
- docs/about/pricing.md (2 hunks)
- docs/about/support.md (2 hunks)
- docs/faq/faq.md (2 hunks)
- docs/introduction/introduction.md (3 hunks)
Additional comments: 16
docs/about/support.md (4)
- 7-8: The introduction sets a welcoming tone and clearly directs users on how to access support. However, consider adding a brief overview of the types of support provided for a more comprehensive introduction.
- 11-14: The section on joining the Discord community is clear and concise. Including the direct link to the Discord server is helpful for users seeking real-time support.
- 4-19: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [16-28]
The instructions for opening support tickets are detailed and informative. Including images for both light and dark modes enhances accessibility. Ensure the images are up-to-date and clearly visible.
Verification successful
The shell script execution confirmed the existence of both
cr_support_help_light.pngandcr_support_help_dark.pngimages in the./docs/about/images/directory. This verifies that the images are present as intended for use in the documentation. However, assessing their visibility, clarity, and relevance requires visual inspection, which is beyond the scope of this verification process. Based on the information available, the documentation's reference to these images is verified as accurate.* 30-31: Providing an email contact option is essential for users who prefer or require direct communication. Ensure the email address is monitored regularly to maintain effective support.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify the visibility and relevance of the images in both light and dark modes. fd 'cr_support_help_light.png' --exec ls fd 'cr_support_help_dark.png' --exec lsLength of output: 171
docs/about/features.md (2)
- 26-28: The explanation of how review feedback is provided is clear and highlights the convenience of using Diff format for code suggestions. Including an image of the review feedback is a good visual aid.
- 32-37: The addition of a review status section is beneficial for users to understand the context of each review. Ensure the image provided gives a clear example of what users can expect to see.
docs/about/pricing.md (1)
- 95-97: The clarification regarding the subscription being limited to human users and not supporting bot users is important for setting expectations. Ensure the wording is clear and unambiguous.
docs/introduction/introduction.md (3)
- 15-18: The section highlighting CodeRabbit's ability to find issues often missed by humans and its learning capability is well articulated. It emphasizes the AI's evolving nature and the benefits of interaction.
- 38-48: The detailed explanation of data storage, privacy, and security practices is crucial for building trust with users. Ensure that the information is accurate and complies with the mentioned standards.
- 69-73: The comparison of CodeRabbit with traditional code review tools effectively highlights its unique features. This section helps users understand the value proposition of CodeRabbit.
docs/faq/faq.md (6)
- 7-13: The FAQ on CodeRabbit's review accuracy sets realistic expectations and emphasizes continuous improvement. This transparency is beneficial for building user trust.
- 15-19: Clarifying the support for all programming languages and the variance in AI model proficiency is important for managing user expectations. Ensure the language is inclusive and encourages feedback for less common languages.
- 21-26: The FAQ on data storage practices reassures users about the privacy and security of their code. It's crucial to maintain this commitment to user trust.
- 33-37: The ability to switch between organizations is a useful feature. Ensure the UI instructions are up-to-date and clear for users to follow.
- 61-61: Highlighting the inclusion of OpenAI costs in the subscription is a valuable clarification for users considering the Pro plan. This could alleviate concerns about additional costs.
- 67-72: The section on customization options is a good addition, but ensure the link to the Get Started page is correct and functional.
Verification successful
The link to the Get Started page in the documentation is verified to be correct, as the file
docs/get-started/signup.mdexists and aligns with the provided link structure. This confirms the functionality and accuracy of the link as mentioned in the documentation.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify the correctness of the Get Started page link. fd 'signup.md' --exec grep -n 'title: Get Started'Length of output: 50
Script:
#!/bin/bash # Broaden the search for any markdown files related to signing up or getting started. fd '.md' --exec grep -l 'Get Started' {}Length of output: 163
Script:
#!/bin/bash # Attempt to find any markdown files named similarly to 'signup.md' or 'get-started.md' to verify the link's target. fd 'signup.md' || fd 'get-started.md'Length of output: 41
There was a problem hiding this comment.
Review Status
Actionable comments generated: 3
Configuration used: CodeRabbit UI
Files ignored due to path filters (22)
docs/about/_category_.ymlis excluded by:!**/*.ymldocs/get-started/images/add2.pngis excluded by:!**/*.pngdocs/get-started/images/add3.pngis excluded by:!**/*.pngdocs/get-started/images/committable-suggestion.pngis excluded by:!**/*.pngdocs/get-started/images/cr_add_repo_dark.pngis excluded by:!**/*.pngdocs/get-started/images/cr_add_repo_gitlab_dark.pngis excluded by:!**/*.pngdocs/get-started/images/cr_add_repo_gitlab_light.pngis excluded by:!**/*.pngdocs/get-started/images/cr_add_repo_light.pngis excluded by:!**/*.pngdocs/get-started/images/cr_dash_dark.pngis excluded by:!**/*.pngdocs/get-started/images/cr_dash_light.pngis excluded by:!**/*.pngdocs/get-started/images/cr_history_dark.pngis excluded by:!**/*.pngdocs/get-started/images/cr_history_light.pngis excluded by:!**/*.pngdocs/get-started/images/cr_login.pngis excluded by:!**/*.pngdocs/get-started/images/cr_login2.pngis excluded by:!**/*.pngdocs/get-started/images/cr_login_dark.pngis excluded by:!**/*.pngdocs/get-started/images/issue-validation.pngis excluded by:!**/*.pngdocs/get-started/images/related-issues.pngis excluded by:!**/*.pngdocs/get-started/images/tailor2.pngis excluded by:!**/*.pngdocs/get-started/images/tailor3.pngis excluded by:!**/*.pngdocs/get-started/images/ymlrabbit.pngis excluded by:!**/*.pngdocs/guides/_category_.ymlis excluded by:!**/*.ymldocs/integrations/_category_.ymlis excluded by:!**/*.yml
Files selected for processing (7)
- docs/faq/faq.md (2 hunks)
- docs/guides/configure-coderabbit.md (7 hunks)
- docs/guides/review-instructions.md (7 hunks)
- docs/integrations/self-hosted-gitlab.md (1 hunks)
- docs/introduction/introduction.md (4 hunks)
- docusaurus.config.ts (1 hunks)
- sidebars.ts (1 hunks)
Additional comments: 11
sidebars.ts (1)
- 16-17: The switch to an autogenerated sidebar configuration is a good practice for maintaining documentation sidebars. It ensures the sidebar stays up-to-date with the file structure automatically.
docs/integrations/self-hosted-gitlab.md (1)
- 67-68: Updating the contact information for VPN tunneling add-on inquiries is a useful update for users seeking more information.
docs/introduction/introduction.md (1)
- 16-19: The transition from "Secondly" to "Additionally" improves the flow and cohesion of the document. This change, along with other semantic adjustments and refinements, enhances the clarity and engagement of the introduction.
docusaurus.config.ts (1)
- 43-52: The updates to the redirects configuration streamline the redirection logic and flow, ensuring users are directed to the correct content efficiently. This is a positive change for user navigation.
docs/faq/faq.md (1)
- 7-13: Introducing new FAQs and updating existing ones significantly enhances the documentation's relevance and usefulness for users. These changes provide more detailed and accurate information, aligning well with the PR objectives.
docs/guides/configure-coderabbit.md (1)
- 2-3: The shift in focus from customization to configuration in the document, including terminology changes and updated YAML file structure, provides clearer guidance on setting up CodeRabbit to meet specific requirements. This is a positive change that enhances the documentation's usefulness.
docs/guides/review-instructions.md (5)
- 2-3: The update to the title and sidebar label to "Review Instructions" accurately reflects the document's new focus and content. This change enhances clarity and aligns with the objective of improving documentation.
- 1-13: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [10-22]
The "Path-based instructions" section provides clear guidance on customizing code review instructions based on file paths. The examples and explanation of using glob patterns are helpful for developers looking to tailor review guidelines for specific parts of their codebase.
- 74-91: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [46-88]
The "Abstract Syntax Tree (AST) based instructions" section offers a comprehensive explanation of using
ast-greprules for custom code review instructions. The detailed guides and examples provided are valuable resources for developers interested in leveraging AST patterns for code reviews.
- 74-91: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [86-208]
The detailed explanation of rule objects, including atomic, relational, and composite rules, is clear and comprehensive. This section effectively guides developers in understanding and creating complex
ast-greprules, enhancing the utility of custom code review instructions.
- 292-311: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [213-358]
The sections on reusing rules as utility, utilizing packages, and supporting multiple programming languages provide valuable guidance on extending the functionality and applicability of
ast-greprules. The informative content enhances understanding of advancedast-grepusage, contributing to more effective and versatile custom code review instructions.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 2
Configuration used: CodeRabbit UI
Files selected for processing (3)
- docs/about/features.md (3 hunks)
- docs/guides/configure-coderabbit.md (7 hunks)
- docs/introduction/introduction.md (4 hunks)
Additional comments: 6
docs/about/features.md (2)
- 26-28: The description of how code suggestions are given could be enhanced for clarity. Consider specifying that the suggestions can be directly applied within the GitHub interface, which might not be clear to all users.
- 32-37: Adding a new section on review status is a valuable addition for providing context. However, it would be beneficial to include an example or a more detailed explanation of how this status can be utilized by users to understand their review progress better.
docs/introduction/introduction.md (3)
- 16-19: The addition of a section highlighting CodeRabbit's ability to find issues often missed by humans and its learning capability from user interactions is insightful. It might be beneficial to include examples of such issues or a brief explanation of how CodeRabbit learns over time to provide readers with a clearer understanding.
- 39-49: The detailed explanation of data storage, privacy practices, and the option to opt out is commendable for transparency. It would enhance understanding further to link to a detailed privacy policy or FAQ section where users can learn more about these practices.
- 70-74: The comparison with traditional code review tools is well-articulated, emphasizing CodeRabbit's unique value proposition. To strengthen this section, consider adding a brief mention of specific best practices that CodeRabbit can advise on, which traditional tools might miss.
docs/guides/configure-coderabbit.md (1)
- 55-71: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [18-113]
The transition from customization to configuration is well-executed, with clear instructions and examples provided in the YAML configuration section. However, it would be beneficial to include a brief explanation or link to further documentation on how to create or modify the
.coderabbit.yamlfile for users unfamiliar with YAML syntax.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Review Status
Actionable comments generated: 3
Configuration used: CodeRabbit UI
Files selected for processing (1)
- docs/integrations/self-hosted-gitlab.md (2 hunks)
Additional comments: 1
docs/integrations/self-hosted-gitlab.md (1)
- 13-26: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-68]
Overall, the document is well-structured and provides clear instructions for integrating Self-Managed GitLab with CodeRabbit. However, consider performing a thorough spell check and grammar review to ensure the highest level of clarity and professionalism.
A thorough spell check and grammar review is recommended to enhance clarity and professionalism.
Comment on lines
+67
to
+68
| VPN tunneling is available as an add-on package. Please reach out to us at | ||
| [contact@coderabbit.ai](mailto:contact@coderabbit.ai) if you are interested. |
There was a problem hiding this comment.
The update to the contact information for VPN tunneling inquiries is clear and straightforward. However, it might be beneficial to also include an alternative contact method, such as a support page or a form on the website, for users who prefer not to use email directly.
Consider adding an alternative contact method for users who prefer not to use email:
VPN tunneling is available as an add-on package. Please reach out to us at
[contact@coderabbit.ai](mailto:contact@coderabbit.ai) if you are interested.
+ For alternative contact methods, please visit our [Support Page](https://coderabbit.ai/support).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.
Suggested change
| VPN tunneling is available as an add-on package. Please reach out to us at | |
| [contact@coderabbit.ai](mailto:contact@coderabbit.ai) if you are interested. | |
| VPN tunneling is available as an add-on package. Please reach out to us at | |
| [contact@coderabbit.ai](mailto:contact@coderabbit.ai) if you are interested. | |
| For alternative contact methods, please visit our [Support Page](https://coderabbit.ai/support). |
| @@ -13,14 +13,14 @@ complete, you can log in directly using the OAuth2 flow. | |||
|
|
|||
| ### **Step 1: Getting Started** | |||
|
|
|||
| **Visit CodeRabbit:** Land on to our [Login](https://coderabbit.ai/login) page | |||
| and select Self-Hosted GitLab | |||
| **Visit CodeRabbit:** Visit our [Login](https://coderabbit.ai/login) page and | |||
There was a problem hiding this comment.
The phrase "Visit CodeRabbit:" is repeated, which might be redundant. Consider simplifying it for clarity and conciseness.
- **Visit CodeRabbit:** Visit our [Login](https://coderabbit.ai/login) page and
+ **Visit our [Login](https://coderabbit.ai/login) page andCommittable 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.
Suggested change
| **Visit CodeRabbit:** Visit our [Login](https://coderabbit.ai/login) page and | |
| **Visit our [Login](https://coderabbit.ai/login) page and |
|
|
||
|  | ||
|
|
||
| ### Step 2: Enter your Self Managed GitLab URL | ||
| ### Step 2: Enter your Self-Managed GitLab URL |
There was a problem hiding this comment.
The phrase "Enter your Self-Managed GitLab URL" could be improved for consistency with the rest of the document's style.
- ### Step 2: Enter your Self-Managed GitLab URL
+ ### Step 2: Entering Your Self-Managed GitLab URLCommittable 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.
Suggested change
| ### Step 2: Enter your Self-Managed GitLab URL | |
| ### Step 2: Entering Your Self-Managed GitLab URL |
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (1)
- docs/guides/configure-coderabbit.md (7 hunks)
Additional comments: 4
docs/guides/configure-coderabbit.md (4)
- 10-11: Consider removing the repeated phrase "Configuration can be made using one of the below options" at the beginning of the document, as it's redundant given the detailed explanation that follows.
- 20-21: The phrase "to the root of your repositories" is clear and correctly includes the article "the" as previously suggested. This addresses the past comment effectively.
- 123-123: The correction to capitalize "Version 1" in the section heading has been made, aligning with the consistency feedback from previous comments.
- 207-207: The link to
[Review Instructions](./review-instructions.md)is a good practice for providing additional context. Ensure that the linked document is up-to-date with the changes made in this PR.Verification successful
The verification process confirmed that
review-instructions.mdwas not updated in this PR. This directly addresses the concern raised in the review comment about ensuring the linked document is up-to-date with the changes made in this PR. Therefore, the review comment stands as valid.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify that the review-instructions.md file has been updated in this PR git diff --name-only | grep "docs/guides/review-instructions.md"Length of output: 64
tyaga001
pushed a commit
that referenced
this pull request
Oct 16, 2024
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: Gur singh <11731008+guritfaq@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
tyaga001
added a commit
that referenced
this pull request
Oct 17, 2024
* Coderabbit Docs Rework (wip) * WIP blog page * Fixed images * Wip added all blogs and docs * ✏️ Remove asterisk from CodeRabbit heading * Add Tailwind CSS configuration and update page title * Update logo href and navbar styling * Update Docusaurus configuration and custom CSS * Update routing and styling * Add sitemap configuration and update redirect paths * blog: cost effective generative ai app * fix: numbering * Update CodeRabbit links in documentation * Update CodeRabbit documentation * Update base URL and redirect to external documentation * Update links to Get Started page * Add new images and update links in docusaurus.config.ts and sidebars.ts * Add redirect to documentation page * Update slug in introduction.md * Update introduction.md and docusaurus.config.ts, delete index.tsx * Add code to change the docs link on the navbar * Remove unnecessary code and add redirect for docs * Update docs link and hide SVG icon * Adjustments for mobile view in custom.css * Update logo size and padding for smaller screens, center Discord link, and hide certain navbar links on mobile * Update image paths in CodeRabbit deep dive blog post * Update image in introduction.md * Update image URL in blog post * Update favicon links in blog post * Update og:image URL in blog post * Update blog post image URLs * Update image URLs in blog posts * feat: added document under integration on integration with self hosted gitlab * Update docs/integrations/self-hosted-gitlab.md Co-authored-by: Karan Singh <ksingh209@gmail.com> * Update docs/integrations/self-hosted-gitlab.md Co-authored-by: Karan Singh <ksingh209@gmail.com> * Update docs/integrations/self-hosted-gitlab.md Co-authored-by: Karan Singh <ksingh209@gmail.com> * Update docs/integrations/self-hosted-gitlab.md Co-authored-by: Karan Singh <ksingh209@gmail.com> * Update docs/integrations/self-hosted-gitlab.md Co-authored-by: Karan Singh <ksingh209@gmail.com> * Update docs/integrations/self-hosted-gitlab.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update docs/integrations/self-hosted-gitlab.md Co-authored-by: Karan Singh <ksingh209@gmail.com> * Update self-hosted-gitlab.md * blog: modern ai stack for devs * citation: codex model use in gh copilot * fix: gh citation link * fix: typo * fix: typo * Update index.md * founderblogmissing * Remove markdown file * Update CodeRabbit description and add privacy and security information * Update link in introduction.md * nit * Add new images and delete old image files * Update self-hosted-gitlab.md * Update customize-coderabbit.md * Update self-hosted-gitlab.md * Update customize-coderabbit.md * format blog file * format all blog files * hide version 1 schema * Update faq.md * Fix images for light and dark mode. Made improvements to docs (#22) * Add ast-grep documentation page * Update the ast-grep documentation to include the coderabbit config file changes * Fix language review * Update coderabbit.yaml schema for ast-grep tool naming * Update coderabbig guide page with new coderabbit.yaml changes * Update 2023-11-13-boosting-engineering-efficiency.md * Move ast-grep documentation under the prompt-customization page * Change ast-grep naming * Correct grammar for ast-grep documentation * update faqs * restructure existing blog posts * Add ast-grep documentation page * Update the ast-grep documentation to include the coderabbit config file changes * Fix language review * Update coderabbit.yaml schema for ast-grep tool naming * Move ast-grep documentation under the prompt-customization page * restructure existing docs * review feedback * add preview image * use directory instead of folder terminology * nit * add disqus comments * fix admonitions * add fn acquisition blog (#27) * add fn acquisition blog * add links * small fix * update blog post * update blog post * update preview image * update preview image * minor update to the FAQ * Daily Standup Reporting Docs (#28) * Add daily standup reporting docs and images * Coderabbit suggestions * Add packages section and update existing docs for ast-grep (#29) * updateschemaexample (#31) * updateschemaexample * Update customize-coderabbit.md * minorchanges (#32) * updatefaq * FAQs * doc fixes (#33) Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: Gur singh <11731008+guritfaq@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * fix path instructions example * change the default example for coderabbit yaml * Blog - AI Code Reviews (#36) * newblog * RenameFolder * updatedesc * update example * blog home page * blog featured posts * AdminAccessToken * FixCasing * updatecasing * update docs * update schema * remove daily standup guide * Update YAML settings in configure-coderabbit.md (#40) * Update YAML settings in configure-coderabbit.md * Add configuration for `languagetool` integration in configure-coderabbit.md * update pricing * remove pnpm * ast-grep update * update knowledge_base settings * mention ast-grep-essentials * add review.profile to docs * update review status * revert review status change * add quotes * minor * improve config docs * add playground link * placeholder for high-level summary * remove v1 config documentation * remove ignore title example * remove ignore title example * UpatePauseCommandMessage * update docs * Update introduction.md * Add config for biome and hadolint (#43) * update auto_incremental_review * improve config docs * chore: Update CodeRabbit configuration settings (#44) * chore: Add config for new tools (#45) * UpdateDataPrivacy * chore: Update SwiftLint configuration file path (#47) * Update self hosted onboarding guide * update auto title * update phpstan instructions * Update npm dependencies and add docusaurus-json-schema-plugin (#49) * Update npm dependencies and add docusaurus-json-schema-plugin * Show CodeRabbit config schema from a file * Update faqs typos (#51) * ♻️ Clean faq typos * 💄 Update .png for support help dark and light mode * ♻️ Misc fixes and improvements * update docs * Create initial Gitlab Saas integration page * Update GitLab page content on the how to section with a note * add tip * update limits * 📝 Add Documentation for Deleting Account (#55) * On-demand report generation docs (#56) * Ondemand report input schema format * On-demand reporting docs * CodeRabbit suggestions * Typo * Add linter documentation (#59) * Add linter documentation - Update sidebar positions in documentation guides * docs: Move linter documentation to tools folder * Add more tools * Add LanguageTool documentation and configuration * Update Biome documentation and configuration * docs: Update linter documentation and configuration * chore: Update tools category label in _category_.yml * chore: Update tools category label and add new tools * docs: Fix typo in Biome linter documentation * chore: Add SwiftLint documentation and configuration * Add golangci-lint, PHPStan, and SwiftLint documentation and configuration * Add Yamllint documentation and configuration * Add Checkov and Gitleaks documentation and configuration * Update tool configuration documentation (#60) * chore: Update tool configuration documentation * Update tool configuration documentation * Update Gitleaks documentation (#61) * Update introduction.md and add video (#62) * Add table for Supported Tools by languages (#63) * Add table for Supported Tools by languages * Update supported tools table and documentation * Update tool configuration documentation * Update introduction and CodeRabbit documentation (#64) * Update introduction and CodeRabbit documentation * Update FAQ documentation * Update CodeRabbit documentation and remove reference to GitHub Copilot * Update CodeRabbit documentation and remove reference to GitHub Copilot * Update default settings for CodeRabbit tools (#65) * feat: added docs for detekt and eslint (#67) * feat: added docs for detekt and eslint * fix: lint * Add segment script and update iframe attributes for YouTube video player (#68) * Improve Documentation Structure and Accessibility in Markdown Files (#69) * Major refactor - Move configure and tools to top level - Update category positions - Move images to static dir - Update links * Update image file name in introduction.md * Update sidebar positions for integrations documentation * Update category positions for documentation * Update knowledge base integration description * Update FAQ with CodeRabbit comparison and CodeRabbit's uniqueness * Update redirects in docusaurus.config.ts * Update Jira and Linear integration configuration in knowledge base * Update GitLab integration documentation * Self-Hosted GitHub onboarding docs (#66) * Initial draft of Self-Hosted GitHub onboarding * Fix issues and reorg steps * Rebase & fix conflicts * sidebar_position * Add step to install GitHub App for Self-Hosted (#70) * Add step to install GitHub App * Disclaimer * Coderabbit suggestion: install -> installation * Coderabbit suggestions * Remove ESLint from JavaScript tools documentation (#71) * Add supported git platforms page in documentation (#72) * Add supported git platforms page in documentation * Fix typo in platforms.md * chore: Update redirect paths in docusaurus.config.ts * added yaml editor (#74) * added yaml editor * name fix * moved component to one code block * removed logs * Feature yaml editor (#76) * added yaml editor * name fix * moved component to one code block * removed logs * fix: yaml editor * fix: reviews * new line * fix: merge fix * Update schema.v2.json * 🎨 Run Markdownlint and Prettier (#84) * added correct scopes (#88) Co-authored-by: dikshant <raidikshant2@gmail.com> * Add Azure DevOps initial docs page * Update Azure DevOps * add redirect * rename AzureDevOps page * SaaS GitLab change to Gitlab.com and added relevant redirect Update GitLab sidebar label and link references in documentation (#93) * SaaS GitLab change to Gitlab.com and added relevant redirect * changes for the self-hosted-github to Github Enterprise Server * Azure DevOps Server Support * Update platforms.md * Remove segment (#104) * update: introduction and added a CTA minor change to recreate the PR --------- Co-authored-by: Karan Singh <ksingh209@gmail.com> Co-authored-by: gitcommitshow <pradeep@gitcommit.show> Co-authored-by: coderabbit-amank <aman@coderabbit.ai> Co-authored-by: Gur singh <11731008+guritfaq@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Gur <guritfaq@gmail.com> Co-authored-by: Harjot Gill <harjot.gill@fluxninja.com> Co-authored-by: Karan Singh <karan@coderabbit.ai> Co-authored-by: petrisorcoderabbit <petrisor@coderabbit.ai> Co-authored-by: Jaseel <12792882+Spikatrix@users.noreply.github.com> Co-authored-by: petrisorcoderabbit <155847819+petrisorcoderabbit@users.noreply.github.com> Co-authored-by: Hasit Mistry <hasitnm@gmail.com> Co-authored-by: Hasit Mistry <hasit@coderabbit.ai> Co-authored-by: Ruhan Muzaffar <ruhan@coderabbit.ai> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Nato Boram <NatoBoram@users.noreply.github.com> Co-authored-by: dikshant-infracloud <160205839+dikshant-infracloud@users.noreply.github.com> Co-authored-by: dikshant <raidikshant2@gmail.com> Co-authored-by: Aravind Putrevu <aravind.putrevu@gmail.com> Co-authored-by: Nick Busey <NickBusey@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit