update: introduction, added a CTA and improved image SEO (#108)

* 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>
coderabbitai · Oct 17, 2024 · 5c706ff · 5c706ff
1 parent 9f5cb6a
commit 5c706ff
Show file tree

Hide file tree

Showing 5 changed files with 167 additions and 46 deletions.
diff --git a/docs/guides/review-instructions.md b/docs/guides/review-instructions.md
@@ -47,6 +47,21 @@ reviews:
 
 ## Abstract Syntax Tree (AST) based instructions {#ast-based}
 
+CodeRabbit offers review instructions based on Abstract Syntax Tree (AST)
+patterns. Under the hood, CodeRabbit uses
+[`ast-grep`](https://ast-grep.github.io) to power this feature. `ast-grep` is
+written in Rust and uses the tree-sitter parser to generate the AST for popular
+languages. `ast-grep` is written and maintained by
+[Herrington Darkholme](https://twitter.com/hd_nvim).
+
+:::tip
+
+`ast-grep` Playground is quite effective in designing and testing AST rules on
+source code snippets. You can access the playground
+[here](https://ast-grep.github.io/playground.html).
+
+:::
+
 :::note
 
 The additional context provided by this feature is only available during the

diff --git a/docs/introduction.md b/docs/introduction.md
@@ -1,57 +1,63 @@
 ---
-id: introduction
-title: Introduction
+id: Get Started
+title: Get Started
 sidebar_label: Introduction
 sidebar_position: 1
 description:
-  CodeRabbit is an innovative, AI-powered code reviewer. It provides context-aware
-  review feedback on a pull request within minutes, thereby significantly
-  reducing the time and effort associated with manual code reviews.
+  CodeRabbit is an AI-powered code reviewer offering real-time, context-aware
+  feedback on pull requests, reducing manual effort in code reviews.
 slug: "/"
 ---
+## What is CodeRabbit?
+
+>**CodeRabbit** is an AI-powered code reviewer that delivers context-aware feedback on pull requests within minutes, reducing the time and effort needed for manual code reviews. It provides a fresh perspective and catches issues that are often missed, enhancing the overall review quality.
+
+Developers can interact directly with the bot within the code, offering additional context, asking questions, or even having the bot generate code. Over time, **CodeRabbit** learns from user input and improves its suggestions.
+
+:::tip
+> See CodeRabbit in action and watch the demo video below to see how it delivers real-time, context-aware feedback on your pull requests in just a few minutes.
+:::
 
 <div class="video-container">
   <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>
 </div>
 
-**CodeRabbit** is an innovative, AI-powered code reviewer. It provides
-context-aware review feedback on a pull request within minutes, thereby
-significantly reducing the time and effort associated with manual code reviews.
-Additionally, it brings a different perspective to the reviews and finds issues
-often missed by the human eye. Developers can chat with the bot within the code,
-which allows them to provide additional context, ask questions, or have the bot
-generate code. It learns from your suggestions and gets better over time.
-
-**CodeRabbit** seamlessly integrates with GitHub and GitLab repositories,
-performing continuous, incremental reviews for each commit within a pull
-request. Review feedback is sent back to the pull requests and can be directly
-committed.
-
-**CodeRabbit** integrates into code repositories using GitHub or GitLab webhooks
-and monitors events related to Pull Request (PR) and Merge Request (MR) changes.
-A comprehensive review is performed when a PR or MR is created, and for
-incremental commits and comments addressed to the bot. The feedback is then sent
-directly back to the PR or MR.
-
-![CodeRabbit Flow](/img/about/coderabbit-flow.png)
-
-## Data, Privacy, and Security
-
-**CodeRabbit** does not use data collected during code reviews to train or
-influence the models. Queries to the Large Language Models (LLMs) are ephemeral
-and there is zero retention on LLMs. Neither we nor the LLMs provider(s) share
-any data collected during the code review process with third parties.
-
-Data storage: Code downloaded during the review process is temporarily stored in
-memory and deleted once the review is completed. The code is not stored or used for
-any other purpose. However, CodeRabbit enhances future reviews for your organization by
-storing the embeddings of the learnings generated from chat conversations. Additionally,
-it integrates embeddings from issues in workflow systems (Linear, Jira, GitHub/GitLab issues)
-to assess the impact of code changes on existing issues.
-
-Compliance and Data Privacy: Your data is kept confidential, isolated by the
-organization, and used only to improve your organization reviews. Data storage
-complies with SOC2 Type II and GDPR standards.
-
-Opting Out: You can choose to opt out of data storage at any time. Opting out
-won't affect your access but will limit the personalization of the reviews.
+## Integration with GitHub and GitLab
+
+>**CodeRabbit** integrates with both GitHub and GitLab repositories to deliver continuous and incremental reviews for each commit in a pull request (PR) or merge request (MR). Review feedback is automatically sent back to the PR/MR and can be committed directly.
+
+It works via GitHub/GitLab webhooks, monitoring Pull Request (PR) and Merge Request (MR) events. A comprehensive review is performed when a PR or MR is created, and for
+incremental commits and comments addressed to the bot. The feedback is then sent directly back to the Pull Request or Merge Request.
+
+![CodeRabbit Code Review Flow showing how AI integrates with GitHub and GitLab for continuous pull request feedback.](/img/about/coderabbit-flow.png "CodeRabbit Code Review Flow")
+
+## Data Privacy and Security
+
+>**CodeRabbit** does not use data collected from code reviews to train or influence its models. All queries to Large Language Models (LLMs) are ephemeral, with zero retention. No data is shared with third parties.
+
+- **Temporary Storage**: Code is temporarily stored in memory during the review process and deleted afterward.
+- **Stored Embeddings**: While the code itself isn’t stored, **CodeRabbit** stores embeddings based on chat conversations and workflow systems (Linear, Jira, GitHub/GitLab issues) to improve future reviews.
+- **Compliance**: All data is kept confidential, isolated by organization, and complies with **SOC2 Type II** and **GDPR** standards.
+
+### Opting Out
+
+You can opt out of data storage at any time without affecting your access to **CodeRabbit**.
+:::warning
+However, opting out may reduce the level of personalized review feedback.
+:::
+
+## Try CodeRabbit Now
+
+>Ready to experience **CodeRabbit** in action?
+
+:::tip
+For open source projects CodeRabbit Pro is **_FREE_**, forever.
+- No credit card required
+- Unlimited public repositories
+:::
+
+<div style={{textAlign: 'left', marginTop: '20px'}}>
+  <a href="https://app.coderabbit.ai/login" className="button button--primary button--lg">Start reviewing PR Now</a>
+</div>
+
+
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
@@ -53,6 +53,23 @@ const config: Config = {
     //    blogPostComponent: "@theme/BlogPostPage",
     //  },
     //],
+    [
+      "./plugins/blog-plugin",
+      {
+        id: "blog",
+        routeBasePath: "blog",
+        path: "./blog",
+        blogTitle: "CodeRabbit Blog",
+        blogDescription: "Blog",
+        tagsBasePath: "/tags",
+        editLocalizedFiles: false,
+        showReadingTime: true,
+        blogSidebarCount: "ALL",
+        blogSidebarTitle: "All our posts",
+        blogListComponent: "@theme/BlogListPage",
+        blogPostComponent: "@theme/BlogPostPage",
+      },
+    ],
     [
       "@docusaurus/plugin-client-redirects",
       {
@@ -97,6 +114,11 @@ const config: Config = {
             from: "/platforms/self-hosted-github",
             to: "/platforms/github-enterprise-server",
           },
+          {
+            from: "/platforms/saas-azure-devops",
+            to: "/platforms/azure-devops",
+          },
+
         ],
       },
     ],
@@ -147,6 +169,10 @@ const config: Config = {
     "https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js",
     "/docs/js/code-block-buttons.js",
     "https://cdnjs.cloudflare.com/ajax/libs/axios/1.2.1/axios.min.js",
+    {
+      src: "/js/segment.js",
+      async: false,
+    },
     {
       src: "https://js.hs-scripts.com/43613284.js",
       type: "text/javascript",

diff --git a/src/css/custom.css b/src/css/custom.css
@@ -99,3 +99,64 @@ a[docid="docs"] > svg {
   width: 100%;
   height: 100%;
 }
+
+.navbar .navbar__item {
+    align-items: center;
+    display: flex;
+    font-size: 1.25rem;
+    font-weight: 700;
+}
+
+a[docid="docs"] > svg {
+    display: none;
+}
+
+/* Adjustments for mobile view */
+@media (max-width: 768px) {
+    /* Reduce the logo size for smaller screens */
+    .navbar__logo img {
+        height: 32px;
+        align-items: center;
+    }
+
+    /* Reduce the padding around the logo for smaller screens */
+    .navbar__logo {
+        padding: 2px; /* Adjust the padding for smaller screens */
+    }
+}
+
+/* Center the Discord link within its parent */
+.navbar__items.navbar__items--right {
+    display: flex;
+    justify-content: center;
+    align-items: center;
+}
+
+@media screen and (max-width: 480px) {
+    a.navbar__item.navbar__link[docid="docs"] {
+        display: none !important;
+    }
+}
+
+@media screen and (max-width: 480px) {
+    a.navbar__item.navbar__link[href="https://blog.coderabbit.ai/blog"]
+    {
+        display: none;
+    }
+}
+
+/* Light mode Discord icon */
+/* .header-discord-link:before {
+    -webkit-filter: invert(100%);
+    filter: invert(100%);
+    content: "";
+    display: flex;
+    height: 16px;
+    width: 20px;
+} */
+
+/* Dark mode Discord icon */
+/* .header-discord-link:before {
+    background: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' height='16' width='20' viewBox='0 0 640 512'%3E%3Cpath fill='%23FFFFFF' d='M524.5 69.8a1.5 1.5 0 0 0 -.8-.7A485.1 485.1 0 0 0 404.1 32a1.8 1.8 0 0 0 -1.9 .9 337.5 337.5 0 0 0 -14.9 30.6 447.8 447.8 0 0 0 -134.4 0 309.5 309.5 0 0 0 -15.1-30.6 1.9 1.9 0 0 0 -1.9-.9A483.7 483.7 0 0 0 116.1 69.1a1.7 1.7 0 0 0 -.8 .7C39.1 183.7 18.2 294.7 28.4 404.4a2 2 0 0 0 .8 1.4A487.7 487.7 0 0 0 176 479.9a1.9 1.9 0 0 0 2.1-.7A348.2 348.2 0 0 0 208.1 430.4a1.9 1.9 0 0 0 -1-2.6 321.2 321.2 0 0 1 -45.9-21.9 1.9 1.9 0 0 1 -.2-3.1c3.1-2.3 6.2-4.7 9.1-7.1a1.8 1.8 0 0 1 1.9-.3c96.2 43.9 200.4 43.9 295.5 0a1.8 1.8 0 0 1 1.9 .2c2.9 2.4 6 4.9 9.1 7.2a1.9 1.9 0 0 1 -.2 3.1 301.4 301.4 0 0 1 -45.9 21.8 1.9 1.9 0 0 0 -1 2.6 391.1 391.1 0 0 0 30 48.8 1.9 1.9 0 0 0 2.1 .7A486 486 0 0 0 610.7 405.7a1.9 1.9 0 0 0 .8-1.4C623.7 277.6 590.9 167.5 524.5 69.8zM222.5 337.6c-29 0-52.8-26.6-52.8-59.2S193.1 219.1 222.5 219.1c29.7 0 53.3 26.8 52.8 59.2C275.3 311 251.9 337.6 222.5 337.6zm195.4 0c-29 0-52.8-26.6-52.8-59.2S388.4 219.1 417.9 219.1c29.7 0 53.3 26.8 52.8 59.2C470.7 311 447.5 337.6 417.9 337.6z'/%3E%3C/svg%3E")
+        no-repeat;
+} */
diff --git a/static/schema/schema.v2.json b/static/schema/schema.v2.json
@@ -774,6 +774,19 @@
 							"additionalProperties": false,
 							"default": {}
 						},
+						"pull_requests": {
+							"type": "object",
+							"properties": {
+								"scope": {
+									"type": "string",
+									"enum": ["local", "global", "auto"],
+									"default": "auto",
+									"description": "Pull Requests | Specify the scope of pull requests to use for the knowledge base. 'local' uses the repository's pull requests, 'global' uses the organization's pull requests, and 'auto' uses repository's pull requests for public repositories and organization's pull requests for private repositories."
+								}
+							},
+							"additionalProperties": false,
+							"default": {}
+						},
 						"pull_requests": {
 							"type": "object",
 							"properties": {