Create an overview page for repository integration

[jmacdotorg]

Conceptual overview of the steps involved with integrating CodeRabbit with any supported Git platform.

List the supported platforms, and outline the common setup steps.

Lead the reader to the platform-specific next page.

Part of the Improved CodeRabbit setup guides and configuration reference content plan.

[linear]

ENG-1831 Create an overview page for repository integration

[traycerai]

Plan

Observations

I analyzed the current documentation structure and found that there's already a basic platforms.md file that lists supported Git platforms in tables with links. However, the GitHub ticket requests a more comprehensive overview page that provides conceptual guidance on integration steps, common setup procedures, and better navigation to platform-specific guides. The current file lacks the educational content and step-by-step overview that would help users understand the integration process before diving into platform-specific details.

Approach

I'll enhance the existing docs/platforms/platforms.md file to transform it from a simple platform listing into a comprehensive repository integration overview. The enhanced page will include a conceptual introduction to CodeRabbit integration, outline the common setup steps across all platforms, maintain the supported platforms listing with improved descriptions, and provide clear navigation paths to platform-specific guides. This approach leverages the existing file structure while significantly improving the user experience and educational value.

Reasoning

I explored the repository structure and examined the existing platform documentation files. I read the current platforms.md file and several platform-specific guides like github-com.md, gitlab-com.mdx, and azure-devops.md to understand the common integration patterns. I also reviewed the sidebar configuration to understand how this content fits into the overall documentation structure.

Proposed File Changes

📄 docs/platforms/platforms.md ^(MODIFY) 🔗

References

• 📄 docs/platforms/github-com.md
• 📄 docs/platforms/gitlab-com.mdx
• 📄 docs/platforms/azure-devops.md
• 📄 docs/getting-started/quickstart.md

Transform this file from a basic platform listing into a comprehensive repository integration overview page. Add a conceptual introduction explaining what CodeRabbit integration involves and its benefits. Include a detailed "Common Integration Steps" section that outlines the universal process: authentication setup, repository access configuration, installation/webhook setup, and configuration customization. Enhance the supported platforms section with better descriptions and clearer navigation. Add a "Getting Started" section that guides users on choosing their platform and next steps. Include troubleshooting tips and links to additional resources. The content should be educational and help users understand the integration process before directing them to platform-specific guides.

Diagram

sequenceDiagram
    participant User
    participant Overview as Repository Integration Overview
    participant Platform as Platform-Specific Guide
    participant CodeRabbit as CodeRabbit App

    User->>Overview: Read integration overview
    Overview->>User: Explain integration concepts
    Overview->>User: Show common setup steps
    Overview->>User: List supported platforms
    User->>Overview: Choose platform
    Overview->>Platform: Direct to platform guide
    Platform->>User: Provide detailed setup steps
    User->>CodeRabbit: Complete integration
    CodeRabbit->>User: Ready for code reviews

Loading

Import In IDE

🤖 Prompt for AI Agents

I have created the following plan after thorough exploration and analysis of the codebase. Follow the below plan verbatim. Trust the files and references. Do not re-verify what's written in the plan. Explore only when absolutely necessary. First implement all the proposed file changes and then I'll review all the changes together at the end. Make sure you fix all the linting, compilation or validation issues after successful implementation of the plan.

### Observations

I analyzed the current documentation structure and found that there's already a basic `platforms.md` file that lists supported Git platforms in tables with links. However, the GitHub ticket requests a more comprehensive overview page that provides conceptual guidance on integration steps, common setup procedures, and better navigation to platform-specific guides. The current file lacks the educational content and step-by-step overview that would help users understand the integration process before diving into platform-specific details.

### Approach

I'll enhance the existing `docs/platforms/platforms.md` file to transform it from a simple platform listing into a comprehensive repository integration overview. The enhanced page will include a conceptual introduction to CodeRabbit integration, outline the common setup steps across all platforms, maintain the supported platforms listing with improved descriptions, and provide clear navigation paths to platform-specific guides. This approach leverages the existing file structure while significantly improving the user experience and educational value.

### Reasoning

I explored the repository structure and examined the existing platform documentation files. I read the current `platforms.md` file and several platform-specific guides like `github-com.md`, `gitlab-com.mdx`, and `azure-devops.md` to understand the common integration patterns. I also reviewed the sidebar configuration to understand how this content fits into the overall documentation structure.

## Mermaid Diagram

sequenceDiagram
    participant User
    participant Overview as Repository Integration Overview
    participant Platform as Platform-Specific Guide
    participant CodeRabbit as CodeRabbit App

    User->>Overview: Read integration overview
    Overview->>User: Explain integration concepts
    Overview->>User: Show common setup steps
    Overview->>User: List supported platforms
    User->>Overview: Choose platform
    Overview->>Platform: Direct to platform guide
    Platform->>User: Provide detailed setup steps
    User->>CodeRabbit: Complete integration
    CodeRabbit->>User: Ready for code reviews

## Proposed File Changes

### docs/platforms/platforms.md(MODIFY)

References: 

- docs/platforms/github-com.md
- docs/platforms/gitlab-com.mdx
- docs/platforms/azure-devops.md
- docs/getting-started/quickstart.md

Transform this file from a basic platform listing into a comprehensive repository integration overview page. Add a conceptual introduction explaining what CodeRabbit integration involves and its benefits. Include a detailed "Common Integration Steps" section that outlines the universal process: authentication setup, repository access configuration, installation/webhook setup, and configuration customization. Enhance the supported platforms section with better descriptions and clearer navigation. Add a "Getting Started" section that guides users on choosing their platform and next steps. Include troubleshooting tips and links to additional resources. The content should be educational and help users understand the integration process before directing them to platform-specific guides.

---

Developer Humor

🚀 From scattered docs to integration zen,
A single page to guide you when!
No more platform confusion,
Clear steps, no illusion,
CodeRabbit setup - easy as 1, 2, 10! 📚✨

---

Execution Information

Branch: main
Commit: b12376e

---

💡 Tips

Supported Commands (Inside Comments)

• Use @traycerai generate to iterate on the previous version of the implementation plan.

Supported Commands (Inside Description)

• Add @traycerai ignore anywhere in the ticket description to prevent this ticket from being processed.
• Add @traycerai branch:<branch-name> anywhere in the ticket description to specify the target branch for the implementation plan.

Community

• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.