Skip to content

Improve Documentation Structure and Accessibility in Markdown Files #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jul 20, 2024

Conversation

hasit
Copy link
Contributor

@hasit hasit commented Jul 20, 2024

Summary by CodeRabbit

  • New Features

    • Added a new documentation file detailing integration with external knowledge bases (Jira and Linear) for issue tracking.
    • Introduced a YouTube video in the introduction to enhance user engagement.
  • Improvements

    • Updated image paths across various documentation files to improve clarity and accessibility.
    • Enhanced sidebar navigation structure with new positions for several documents.
    • Modified the title of the introduction for better alignment with documentation standards.
    • Changed the documentation title from "Tools" to "Supported Tools" for improved clarity.
  • Bug Fixes

    • Corrected minor typographical errors in existing documentation.

@hasit hasit self-assigned this Jul 20, 2024
Copy link
Contributor

coderabbitaidev bot commented Jul 20, 2024

Walkthrough

The documentation has been significantly updated to enhance organization and accessibility, primarily by restructuring image paths from relative to absolute formats. This ensures consistent image loading across various contexts. Additionally, several files received metadata adjustments, such as sidebar positions and title changes, improving navigation and clarity. Overall, these modifications streamline the documentation while preserving its core content and functionality.

Changes

Files Change Summary
docs/about/features.md, docs/about/pricing.md, docs/about/support.md Updated image paths from ./images/... to /img/about/... for better organization and accessibility.
docs/faq.md, docs/guides/delete-account.md, docs/guides/ondemand-reports.md Modified image paths to absolute formats. Added new entries in faq.md and corrected a typographical error.
docs/configure-coderabbit.md Changed sidebar_position from 1 to 3, affecting the sidebar order.
docs/faq.md, docs/introduction.md Added new sidebar positions and updated image paths. The introduction title was changed for clarity.
docs/integrations/knowledge-base.md, docs/integrations/saas-gitlab.md, docs/integrations/self-hosted-gitlab.md Introduced new documents and updated image paths, with sidebar positions added for better navigation.
docs/tools/tools.md Changed title and sidebar label from "Tools" to "Supported Tools" for improved clarity.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CodeRabbit
    participant Documentation
    User->>Documentation: Requests information
    Documentation->>CodeRabbit: Retrieves relevant data
    CodeRabbit-->>Documentation: Returns structured information
    Documentation-->>User: Displays updated content
Loading

Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coderabbitaidev coderabbitaidev bot changed the title @coderabbitai Improve Documentation Structure and Accessibility in Markdown Files Jul 20, 2024
Copy link

cloudflare-workers-and-pages bot commented Jul 20, 2024

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 1de9959
Status: ✅  Deploy successful!
Preview URL: https://1b314ee2.coderabbit-docs.pages.dev
Branch Preview URL: https://hasit-docs-cleanup.coderabbit-docs.pages.dev

View logs

Copy link
Contributor

@coderabbitaidev coderabbitaidev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4b20874 and 44f57e0.

Files ignored due to path filters (37)
  • docs/about/images/CodeRabbitFlow.png is excluded by !**/*.png, !**/*.png and included by none
  • docs/guides/_category_.yml is excluded by !**/*.yml and included by none
  • docs/guides/tools/_category_.yml is excluded by !**/*.yml and included by none
  • docs/integrations/_category_.yml is excluded by !**/*.yml and included by none
  • docs/tools/_category_.yml is excluded by !**/*.yml and included by none
  • static/img/about/ReviewFeedback.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/ReviewStatus.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/Summary-Overview.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/Summary-Walkthrough.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/app-logo.svg is excluded by !**/*.svg, !**/*.svg and included by none
  • static/img/about/chat.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/coderabbit-flow.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/committable-suggestion.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/cr_seat_free_dark.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/cr_seat_free_light.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/cr_seat_manage_dark.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/cr_seat_manage_light.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/cr_support_help_dark.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/cr_support_help_light.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/help1.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/help2.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/help3.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/issue-validation.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/faq/cr_support_orgs_dark.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/faq/cr_support_orgs_light.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/guides/api_keys.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/guides/delete_account_dark.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/guides/delete_account_light.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/integrations/admin-access-token.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/integrations/automated-onboarding.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/integrations/gitlab_organization_user.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/integrations/gitlab_user_choice.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/integrations/login-page.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/integrations/logo.svg is excluded by !**/*.svg, !**/*.svg and included by none
  • static/img/integrations/manual-onboarding.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/integrations/self-hosted-gitlab-host-url.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/integrations/self-hosted-page.png is excluded by !**/*.png, !**/*.png and included by none
Files selected for processing (13)
  • docs/about/features.md (2 hunks)
  • docs/about/pricing.md (1 hunks)
  • docs/about/support.md (2 hunks)
  • docs/configure-coderabbit.md (1 hunks)
  • docs/faq.md (5 hunks)
  • docs/guides/delete-account.md (1 hunks)
  • docs/guides/ondemand-reports.md (1 hunks)
  • docs/guides/review-instructions.md (1 hunks)
  • docs/integrations/knowledge-base.md (1 hunks)
  • docs/integrations/saas-gitlab.md (3 hunks)
  • docs/integrations/self-hosted-gitlab.md (4 hunks)
  • docs/introduction.md (4 hunks)
  • docs/tools/tools.md (1 hunks)
Files skipped from review due to trivial changes (9)
  • docs/about/features.md
  • docs/about/pricing.md
  • docs/about/support.md
  • docs/configure-coderabbit.md
  • docs/guides/delete-account.md
  • docs/guides/ondemand-reports.md
  • docs/guides/review-instructions.md
  • docs/integrations/self-hosted-gitlab.md
  • docs/tools/tools.md
Additional context used
LanguageTool
docs/integrations/knowledge-base.md

[uncategorized] ~21-~21: You might be missing the article “the” here.
Context: ...guration 1. Add Jira's Project Keys to knowledge_base.jira.project_keys field ...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

docs/integrations/saas-gitlab.md

[style] ~45-~45: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...easy identification and management. * **Use the CodeRabbit logo as the profile pict...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

Additional comments not posted (21)
docs/integrations/knowledge-base.md (5)

1-6: Front matter looks good.

The metadata fields are correctly defined.


8-8: Introduction looks good.

The explanation is clear and concise.


10-18: Jira integration instructions look good.

The step-by-step instructions are clear and easy to follow.


23-31: Linear integration instructions look good.

The step-by-step instructions are clear and easy to follow.


32-34: Linear configuration instructions look good.

The instructions are clear and easy to follow.

docs/introduction.md (4)

Line range hint 1-8:
Front matter looks good.

The metadata fields and the updated title are correctly defined.


13-13: YouTube video iframe addition looks good.

The iframe is correctly embedded and the attributes are properly set.


Line range hint 14-33:
Introductory content looks good.

The content is clear, concise, and accurately describes CodeRabbit's features.


34-34: Image path modification looks good.

The updated path is correct and accessible.

docs/integrations/saas-gitlab.md (5)

Line range hint 1-5:
Front matter looks good.

The metadata fields and the new sidebar position entry are correctly defined.


7-7: Introduction looks good.

The explanation is clear and concise.


30-30: Image path modification looks good.

The updated path is correct and accessible.


38-38: Image path modification looks good.

The updated path is correct and accessible.


70-70: Image path modification looks good.

The updated path is correct and accessible.

docs/faq.md (7)

5-5: LGTM!

The addition of sidebar_position: 7 is correctly formatted.


41-42: LGTM!

The image paths for light and dark modes are correctly formatted.


50-58: LGTM!

The new section comparing CodeRabbit to other AI code generators is well-written and informative.


60-66: LGTM!

The new section differentiating CodeRabbit from other code review tools is well-written and informative.


96-96: LGTM!

The link reference for the customization guide is correctly formatted.


145-147: LGTM!

The new section about who can install CodeRabbit on repositories is clear and informative.


155-155: LGTM!

The link reference for the support page is correctly formatted.

Copy link
Contributor

@coderabbitaidev coderabbitaidev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4b20874 and 07a19d2.

Files ignored due to path filters (38)
  • docs/about/images/CodeRabbitFlow.png is excluded by !**/*.png, !**/*.png and included by none
  • docs/guides/_category_.yml is excluded by !**/*.yml and included by none
  • docs/guides/tools/_category_.yml is excluded by !**/*.yml and included by none
  • docs/integrations/_category_.yml is excluded by !**/*.yml and included by none
  • docs/tools/_category_.yml is excluded by !**/*.yml and included by none
  • docusaurus.config.ts is excluded by none and included by none
  • static/img/about/ReviewFeedback.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/ReviewStatus.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/Summary-Overview.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/Summary-Walkthrough.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/app-logo.svg is excluded by !**/*.svg, !**/*.svg and included by none
  • static/img/about/chat.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/coderabbit-flow.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/committable-suggestion.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/cr_seat_free_dark.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/cr_seat_free_light.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/cr_seat_manage_dark.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/cr_seat_manage_light.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/cr_support_help_dark.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/cr_support_help_light.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/help1.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/help2.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/help3.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/about/issue-validation.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/faq/cr_support_orgs_dark.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/faq/cr_support_orgs_light.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/guides/api_keys.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/guides/delete_account_dark.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/guides/delete_account_light.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/integrations/admin-access-token.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/integrations/automated-onboarding.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/integrations/gitlab_organization_user.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/integrations/gitlab_user_choice.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/integrations/login-page.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/integrations/logo.svg is excluded by !**/*.svg, !**/*.svg and included by none
  • static/img/integrations/manual-onboarding.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/integrations/self-hosted-gitlab-host-url.png is excluded by !**/*.png, !**/*.png and included by none
  • static/img/integrations/self-hosted-page.png is excluded by !**/*.png, !**/*.png and included by none
Files selected for processing (13)
  • docs/about/features.md (2 hunks)
  • docs/about/pricing.md (1 hunks)
  • docs/about/support.md (2 hunks)
  • docs/configure-coderabbit.md (1 hunks)
  • docs/faq.md (5 hunks)
  • docs/guides/delete-account.md (1 hunks)
  • docs/guides/ondemand-reports.md (1 hunks)
  • docs/guides/review-instructions.md (1 hunks)
  • docs/integrations/knowledge-base.md (1 hunks)
  • docs/integrations/saas-gitlab.md (3 hunks)
  • docs/integrations/self-hosted-gitlab.md (4 hunks)
  • docs/introduction.md (4 hunks)
  • docs/tools/tools.md (1 hunks)
Files skipped from review due to trivial changes (10)
  • docs/about/features.md
  • docs/about/pricing.md
  • docs/about/support.md
  • docs/configure-coderabbit.md
  • docs/guides/delete-account.md
  • docs/guides/ondemand-reports.md
  • docs/guides/review-instructions.md
  • docs/integrations/self-hosted-gitlab.md
  • docs/introduction.md
  • docs/tools/tools.md
Additional context used
LanguageTool
docs/integrations/knowledge-base.md

[uncategorized] ~21-~21: You might be missing the article “the” here.
Context: ...guration 1. Add Jira's Project Keys to knowledge_base.jira.project_keys field ...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

docs/integrations/saas-gitlab.md

[uncategorized] ~32-~32: Possible missing comma found.
Context: ... the default CodeRabbit user** for most organizations as it is pre-configured. However, we un...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~45-~45: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...easy identification and management. * **Use the CodeRabbit logo as the profile pict...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

Additional comments not posted (12)
docs/integrations/knowledge-base.md (4)

1-6: Metadata section looks good.

The metadata is well-structured and correctly formatted.


8-8: Introduction section looks good.

The introduction is clear and concise, providing a good overview of the integration.


23-35: Linear integration section looks good.

The instructions are clear and easy to follow.


36-36: Links section looks good.

The link is correctly formatted and functional.

docs/integrations/saas-gitlab.md (3)

Line range hint 1-5:
Metadata section looks good.

The metadata is well-structured and correctly formatted.


7-7: Introduction section looks good.

The introduction is clear and concise, providing a good overview of the integration.


30-38: Image paths section looks good.

The image paths are correctly formatted and functional.

Also applies to: 70-70

Tools
LanguageTool

[uncategorized] ~32-~32: Possible missing comma found.
Context: ... the default CodeRabbit user** for most organizations as it is pre-configured. However, we un...

(AI_HYDRA_LEO_MISSING_COMMA)

docs/faq.md (5)

Line range hint 1-5:
Metadata section looks good.

The metadata is well-structured and correctly formatted.


41-42: General section looks good.

The FAQs are clear and informative. The image paths for switching organizations are correctly updated.


50-66: CodeRabbit comparison section looks good.

The FAQs are clear and provide useful information.


68-68: Subscription section looks good.

The FAQs are clear and provide useful information.


Line range hint 96-145:
Usage and Configuration section looks good.

The FAQs are clear and provide useful information. The typographical error in "organization" is correctly fixed.

Copy link
Contributor

@coderabbitaidev coderabbitaidev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 07a19d2 and dd0ac3b.

Files selected for processing (1)
  • docs/integrations/knowledge-base.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • docs/integrations/knowledge-base.md

@hasit hasit merged commit 822941d into main Jul 20, 2024
1 check passed
@hasit hasit deleted the hasit/docs-cleanup branch July 20, 2024 05:33
Copy link
Contributor

@coderabbitaidev coderabbitaidev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between dd0ac3b and 1de9959.

Files selected for processing (1)
  • docs/integrations/saas-gitlab.md (3 hunks)
Additional context used
LanguageTool
docs/integrations/saas-gitlab.md

[style] ~45-~45: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...easy identification and management. * **Use the CodeRabbit logo as the profile pict...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

Additional comments not posted (4)
docs/integrations/saas-gitlab.md (4)

5-5: LGTM!

The addition of sidebar_position: 1 is appropriate for reordering the navigation structure.


32-32: LGTM!

The sentence structure improvement enhances readability.


38-38: LGTM!

The updated image path ensures consistency in how images are referenced.


45-45: LGTM!

The improved sentence structure avoids repetition and enhances readability.

Tools
LanguageTool

[style] ~45-~45: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...easy identification and management. * **Use the CodeRabbit logo as the profile pict...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

tyaga001 pushed a commit that referenced this pull request Oct 16, 2024
)

* 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
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 <[email protected]>

* Update docs/integrations/self-hosted-gitlab.md

Co-authored-by: Karan Singh <[email protected]>

* Update docs/integrations/self-hosted-gitlab.md

Co-authored-by: Karan Singh <[email protected]>

* Update docs/integrations/self-hosted-gitlab.md

Co-authored-by: Karan Singh <[email protected]>

* Update docs/integrations/self-hosted-gitlab.md

Co-authored-by: Karan Singh <[email protected]>

* 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 <[email protected]>

* 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 <[email protected]>
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 <[email protected]>

* 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 <[email protected]>
Co-authored-by: gitcommitshow <[email protected]>
Co-authored-by: coderabbit-amank <[email protected]>
Co-authored-by: Gur singh <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Gur <[email protected]>
Co-authored-by: Harjot Gill <[email protected]>
Co-authored-by: Karan Singh <[email protected]>
Co-authored-by: petrisorcoderabbit <[email protected]>
Co-authored-by: Jaseel <[email protected]>
Co-authored-by: petrisorcoderabbit <[email protected]>
Co-authored-by: Hasit Mistry <[email protected]>
Co-authored-by: Hasit Mistry <[email protected]>
Co-authored-by: Ruhan Muzaffar <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Nato Boram <[email protected]>
Co-authored-by: dikshant-infracloud <[email protected]>
Co-authored-by: dikshant <[email protected]>
Co-authored-by: Aravind Putrevu <[email protected]>
Co-authored-by: Nick Busey <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant