🐰 New: Triage — a self-updating cross-repository queue that prioritizes pull requests by value and risk, so you always know what to review next. Explore Triage →
Turn ideas, issues, PRDs, and designs into precise Coding Plans grounded in your codebase, then hand them off to any coding agent.
Platform Tour guides you through all major CodeRabbit features and surfaces. For the detailed documentation on CodeRabbit Plan, follow this link.
CodeRabbit Plan turns your ideas into detailed, project-aware Coding Plans you can review, refine, and hand off to any coding agent. Because every plan is grounded in deep codebase understanding and enriched by your project Knowledge Base, it references the right files, follows your established patterns, and produces agent-ready prompts, not generic outlines.
The fastest way to get started is the CodeRabbit web app. Go to app.coderabbit.ai/plan, describe what you want to build in free-form text, select a repository, and click Create plan. The form also supports file attachments.See the Create a plan guide for the full step-by-step walkthrough.
You can generate Coding Plans directly from your issue tracker. Comment @coderabbitai plan on any issue, or enable auto-planning to generate plans automatically when issues match your rules.
GitHub
GitLab
Azure DevOps
Jira
Linear
Codebase understanding
Analyzes your repository’s architecture, patterns, and existing code so
every plan fits naturally into how your project is built.
Project context
Draws on related issues, design documents, and accumulated to
ground every plan in your project’s broader context.
Chat with CodeRabbit to refine details, challenge design choices, or request changes. The conversation is collaborative: product owners and other team members can participate too, ensuring the plan reflects the team’s knowledge.
Web app
Issue Trackers (GitHub & GitLab)
Review, tune, and adjust your Coding Plan in the CodeRabbit web app. Use the
chat panel to iterate on the plan until it’s ready.
Coding Plan in the CodeRabbit web app
The full Coding Plan is posted as a comment directly on the issue. Reply to
the plan comment to refine details, challenge design choices, or request
changes.
Coding Plan posted as a comment on a GitHub issue
Collaborative Planning
Plans are available for review by engineers and product owners. Team members discuss, challenge design choices, and refine plans together.
Accountability and history
Every plan version is preserved. Track what was planned, when it was planned, and why decisions were made.
Once the plan reflects the team’s decisions, hand off the finalized prompts to your coding agent of choice. The agent receives precise, codebase-aware instructions it can act on immediately.
Agent-ready prompts
Finalized plans are exported as structured, codebase-aware prompts that any coding agent can act on immediately — no reinterpretation required.
Any coding agent
Hand off to Claude Code, Codex, Cursor, Gemini, or any other coding agent. The prompt format is agent-agnostic.
Full documentation covering the web interface, plan structure, refinement, and Agent Handoff.
Issue-based planning
Platform-specific guides for generating Coding Plans from GitHub, GitLab, Azure DevOps, Jira, and Linear issues.
CodeRabbit Agent for Slack
Bring AI-powered investigation, planning, and code editing into your Slack workspace.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"CodeRabbit","description":"Guides for Agentic Change Management: review, prioritize, understand, and secure changes across pull requests, your IDE, CLI, and team chat.","colors":{"primary":"#FF570A","light":"#FF570A","dark":"#FF570A"},"logo":{"light":"https://mintcdn.com/coderabbit/qAZa_d7FrwPO_w-O/coderabbit-logo-light.svg?fit=max\u0026auto=format\u0026n=qAZa_d7FrwPO_w-O\u0026q=85\u0026s=d2bf9e91be0e760ec9cb468676fa6ab6","dark":"https://mintcdn.com/coderabbit/qAZa_d7FrwPO_w-O/coderabbit-logo-dark.svg?fit=max\u0026auto=format\u0026n=qAZa_d7FrwPO_w-O\u0026q=85\u0026s=feeb1667ed4a2768a15b271f130395c0","href":"/"},"favicon":{"light":"https://mintcdn.com/coderabbit/qAZa_d7FrwPO_w-O/favicon-light.svg?fit=max\u0026auto=format\u0026n=qAZa_d7FrwPO_w-O\u0026q=85\u0026s=c0b0fbea23b48949cc631606f2a30022","dark":"https://mintcdn.com/coderabbit/qAZa_d7FrwPO_w-O/favicon-dark.svg?fit=max\u0026auto=format\u0026n=qAZa_d7FrwPO_w-O\u0026q=85\u0026s=4db7fc04860b6907c7f236f05b37f5c6"},"api":{"openapi":"openapi.json","playground":{"display":"simple"}},"navbar":{"primary":{"type":"button","label":"Sign up","href":"https://app.coderabbit.ai/login?free-trial="}},"footer":{"socials":{"x":"https://x.com/coderabbitai","linkedin":"https://www.linkedin.com/company/coderabbitai","github":"https://github.com/coderabbitai","discord":"https://discord.gg/GsXnASn26c"},"links":[{"header":"Resources","items":[{"label":"Blog","href":"https://coderabbit.ai/blog"},{"label":"Pricing","href":"https://www.coderabbit.ai/pricing"},{"label":"Changelog","href":"https://docs.coderabbit.ai/changelog"},{"label":"Support knowledge base","href":"https://kb.coderabbit.ai"}]},{"header":"Quick links","items":[{"label":"Schedule a demo","href":"https://www.coderabbit.ai/contact-us/sales"},{"label":"Get support","href":"https://docs.coderabbit.ai/support"},{"label":"Status page","href":"https://status.coderabbit.ai"},{"label":"Terms of service","href":"https://www.coderabbit.ai/terms-of-service"},{"label":"Privacy Policy","href":"https://coderabbit.ai/privacy-policy"}]}]},"seo":{"metatags":{"description":"Guides for Agentic Change Management: review, prioritize, understand, and secure changes across pull requests, your IDE, CLI, and team chat.","og:type":"website","og:site_name":"CodeRabbit Documentation","og:locale":"en_US","twitter:card":"summary_large_image","twitter:site":"@coderabbitai","canonical":"https://docs.coderabbit.ai"}},"fonts":{"heading":{"family":"Geist"},"body":{"family":"Geist"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","latex":true},"integrations":{"gtm":{"tagId":"GTM-5BWLXJRC"},"posthog":{"apiKey":"phc_6fDZRN9hYzB83I7Fk2GNHYqas4WMIdGBQ58aZ6EOZR0"}},"banner":{"content":"🐰 New: **Triage** — a self-updating cross-repository queue that prioritizes pull requests by value and risk, so you always know what to review next. [Explore Triage →](/triage)","dismissible":true,"type":"info","color":{"light":"#171717","dark":"#171717"}},"errors":{"404":{"redirect":false,"title":"Page Not Found. Sorry!","description":"Try **Search** or **Ask AI** to find what you're looking for.\nPress \u003ckbd>⌘K\u003c/kbd> (Mac) or \u003ckbd>Ctrl+K\u003c/kbd> (Windows/Linux) to open the search.\n\n\nNeed help? [Get support](/support)."}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Quickstart","icon":"rocket","hidden":false,"href":"/getting-started/quickstart"},{"anchor":"Blog","icon":"pen-line","hidden":true,"href":"https://coderabbit.ai/blog"},{"anchor":"Changelog","icon":"history","href":"/changelog"},{"anchor":"Support","icon":"life-buoy","href":"/support"},{"anchor":"Discord","icon":"discord","href":"https://discord.gg/coderabbit"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"coderabbit","hasAudioNarration":false,"actualSubdomain":"coderabbit","customDomains":["docs.coderabbit.ai"],"gitSource":{"type":"github","owner":"coderabbitai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae49e85f49f5b7aedfdd4da","collectionId":"8aa99ef7-0b49-4db8-9b91-13e240b5d50a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae49e85f49f5b7aedfdd4da"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae49e85f49f5b7aedfdd4da","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"CodeRabbit Platform","count":158},{"language":"default","tag":"Management","count":76},{"language":"default","tag":"Tools","count":62},{"language":"default","tag":"Per-tool guides","count":59},{"language":"default","tag":"Languages","count":39},{"language":"default","tag":"CLI and IDE tools","count":27},{"language":"default","tag":"CodeRabbit API","count":23},{"language":"default","tag":"Agent for Slack and Discord","count":21},{"language":"default","tag":"API Reference","count":21},{"language":"default","tag":"Agent for Slack","count":15}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"overview/coderabbit-plan","slug":"/overview/coderabbit-plan","pageMetadata":{"title":"CodeRabbit Plan","sidebarTitle":"CodeRabbit Plan","description":"Turn ideas, issues, PRDs, and designs into precise Coding Plans grounded in your codebase, then hand them off to any coding agent.","mode":"wide","href":"/overview/coderabbit-plan"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Turn ideas, issues, PRDs, and designs into precise Coding Plans grounded in your codebase, then hand them off to any coding agent.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const Hint=({type,children,headline,tip,href,cta})=>{const{Tooltip}=_provideComponents()||{};if(!Tooltip)_missingMdxReference(`Tooltip`,true);const TIPS={learnings:{headline:`Learnings`,tip:`Review preferences CodeRabbit learns from your chat conversations and applies automatically to future reviews.`,cta:`Learn about Learnings`,href:`/knowledge-base/learnings`,content:`Learnings`},walkthrough:{headline:`PR Walkthrough`,tip:`A structured comment posted by CodeRabbit at the top of every pull request, summarizing changes, sequence diagrams, review effort, and more.`,cta:`Learn about PR Walkthroughs`,href:`/pr-reviews/walkthroughs`,content:`Walkthrough`},\"finishing-touches\":{headline:`Finishing Touches`,tip:`Post-review agentic actions (Fix comments, writing docstrings or unit tests, and more) you trigger from a PR comment or a checkbox in the Walkthrough.`,cta:`See all Finishing Touches`,href:`/finishing-touches`,content:`Finishing Touches`},\"coding-plan\":{headline:`Coding Plan`,tip:`A detailed, codebase-aware implementation plan CodeRabbit generates from an issue or description, ready to hand off to any coding agent.`,cta:`Learn about Coding Plans`,href:`/plan`,content:`Coding Plan`},\"knowledge-base\":{headline:`Knowledge Base`,tip:`The collected context sources CodeRabbit draws on during reviews: Learnings, Code Guidelines, issue trackers, connected MCP servers, and cross-repo analysis.`,cta:`Explore the Knowledge Base`,href:`/knowledge-base`,content:`Knowledge Base`},\"path-instructions\":{headline:`Path Instructions`,tip:`Custom review rules that only apply to files matching a glob pattern, e.g. 'src/controllers/**'.`,cta:`Configure path instructions`,href:`/configuration/path-instructions`,content:`Path Instructions`},\"change-stack\":{headline:`Change Stack`,tip:`An improved code inspection interface that reorganizes a pull request from a flat file list into a structured, layer-by-layer walkthrough with range-specific summaries and diagrams when useful.`,cta:`Learn about Change Stack`,href:`/change-stack`,content:`Change Stack`},scope:{headline:`Scope`,tip:`A named set of repositories, connections, and spend limits that controls what CodeRabbit Agent can access in a given Slack conversation.`,cta:`Learn about Scopes`,href:`/slack-agent/scopes`,content:`Scope`},\"coderabbit-agent\":{headline:`CodeRabbit Agent for Slack`,tip:`An AI agent built into Slack that investigates issues, generates implementation plans, and opens pull requests right from the Slack threads.`,cta:`Explore CodeRabbit Agent`,href:`/slack-agent`,content:`CodeRabbit Agent`},\"configuration-inheritance\":{headline:`Configuration Inheritance`,tip:`A setting that merges configuration values across multiple levels — repository YAML, central YAML, and UI settings — instead of using only the highest-priority source.`,cta:`Learn about Configuration Inheritance`,href:`/configuration/configuration-inheritance`,content:`Configuration Inheritance`},\"coding-agent\":{headline:`Coding Agent`,tip:`Turns a user request, a review finding, a coding plan or a failing CI check into a task that CodeRabbit's agent implements in the cloud, then delivers as a commit or a stacked pull request for you to approve.`,cta:`Learn about Coding Agent`,href:`/code`,content:`Coding Agent`},triage:{headline:`Triage`,tip:`A single cross-repository queue of open pull requests, ranked by what each one needs next and what acting on it is worth.`,cta:`Learn about Triage`,href:`/triage`,content:`Triage`}};const defaults=TIPS[type]||{};return _jsx(Tooltip,{headline:headline??defaults.headline,tip:tip??defaults.tip,cta:cta??defaults.cta,href:href??defaults.href,children:children??defaults.content})};function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Card,CardGroup,Frame,Heading,Info,OptimizedImage,Tab,Tabs,_MdxComponentBoundary}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Tab)_missingMdxReference(`Tab`,true);if(!Tabs)_missingMdxReference(`Tabs`,true);if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsxs(_Fragment,{children:[_jsx(Info,{children:_jsxs(_components.p,{children:[`Platform Tour guides you through all major CodeRabbit features and surfaces. For the detailed documentation on CodeRabbit Plan, follow `,_jsx(_components.a,{href:`/plan`,children:`this link`}),`.`]})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`/plan`,children:`CodeRabbit Plan`}),` turns your ideas into detailed, project-aware Coding Plans you can review, refine, and hand off to any coding agent. Because every plan is grounded in `,_jsx(_components.a,{href:`/overview/architecture`,children:`deep codebase understanding`}),` and enriched by your project `,_jsx(_components.a,{href:`/knowledge-base`,children:`Knowledge Base`}),`, it references the right files, follows your established patterns, and produces agent-ready prompts, not generic outlines.`]}),`\n`,_jsx(Heading,{level:`2`,id:`1-create-a-plan`,children:`1. Create a plan`}),`\n`,_jsxs(Tabs,{children:[_jsxs(Tab,{title:`Using web interface`,id:`using-web-interface`,children:[_jsxs(_components.p,{children:[`The fastest way to get started is the CodeRabbit web app. Go to `,_jsx(_components.a,{href:`https://app.coderabbit.ai/plan/new`,children:`app.coderabbit.ai/plan`}),`, describe what you want to build in free-form text, select a repository, and click `,_jsx(_components.strong,{children:`Create plan`}),`. The form also supports file attachments.`]}),_jsxs(_components.p,{children:[`See the `,_jsx(_components.a,{href:`/plan/create-plan`,children:`Create a plan guide`}),` for the full step-by-step walkthrough.`]})]}),_jsxs(Tab,{title:`Using issue tracker`,id:`using-issue-tracker`,children:[_jsxs(_components.p,{children:[`You can generate Coding Plans directly from your issue tracker. Comment `,_jsx(_components.code,{children:`@coderabbitai plan`}),` on any issue, or enable auto-planning to generate plans automatically when issues match your rules.`]}),_jsxs(CardGroup,{cols:4,children:[_jsx(Card,{title:`GitHub`,icon:`github`,href:`/issues/planner/github`,horizontal:true}),_jsx(Card,{title:`GitLab`,icon:`gitlab`,href:`/issues/planner/gitlab`,horizontal:true}),_jsx(Card,{title:`Azure DevOps`,icon:`microsoft`,href:`/issues/planner/azure-devops`,horizontal:true}),_jsx(Card,{title:`Jira`,icon:`jira`,href:`/issues/planner/jira`,horizontal:true}),_jsx(Card,{title:`Linear`,icon:`linear`,href:`/issues/planner/linear`,horizontal:true})]})]})]}),`\n`,_jsx(`br`,{}),`\n`,_jsxs(CardGroup,{cols:1,children:[_jsx(Card,{title:`Codebase understanding`,icon:`code-xml`,horizontal:true,children:_jsx(_components.p,{children:`Analyzes your repository’s architecture, patterns, and existing code so\nevery plan fits naturally into how your project is built.`})}),_jsx(Card,{title:`Project context`,icon:`database`,horizontal:true,children:_jsxs(_components.p,{children:[`Draws on related issues, design documents, and accumulated `,_jsx(_MdxComponentBoundary,{name:`Hint`,children:_jsx(Hint,{type:`learnings`,children:`learnings`})}),` to\nground every plan in your project’s broader context.`]})})]}),`\n`,_jsx(Heading,{level:`2`,id:`2-refine`,children:`2. Refine`}),`\n`,_jsx(_components.p,{children:`Chat with CodeRabbit to refine details, challenge design choices, or request changes. The conversation is collaborative: product owners and other team members can participate too, ensuring the plan reflects the team’s knowledge.`}),`\n`,_jsxs(Tabs,{children:[_jsxs(Tab,{title:`Web app`,id:`web-app`,children:[_jsx(_components.p,{children:`Review, tune, and adjust your Coding Plan in the CodeRabbit web app. Use the\nchat panel to iterate on the plan until it’s ready.`}),_jsx(Frame,{caption:`Coding Plan in the CodeRabbit web app`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/coderabbit/0_UNDuRPehZvImxS/assets/images/plan-editor.png?fit=max\u0026auto=format\u0026n=0_UNDuRPehZvImxS\u0026q=85\u0026s=675d1c116a50b922932579684cb300c3`,alt:`Coding Plan in the CodeRabbit web app`,\"data-og-width\":`2918`,width:`2918`,\"data-og-height\":`1596`,height:`1596`,\"data-path\":`assets/images/plan-editor.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/coderabbit/0_UNDuRPehZvImxS/assets/images/plan-editor.png?w=280\u0026fit=max\u0026auto=format\u0026n=0_UNDuRPehZvImxS\u0026q=85\u0026s=1d373b47d899ba7188037bfe9a02d0dc 280w, https://mintcdn.com/coderabbit/0_UNDuRPehZvImxS/assets/images/plan-editor.png?w=560\u0026fit=max\u0026auto=format\u0026n=0_UNDuRPehZvImxS\u0026q=85\u0026s=fbfad31bef68e0fba7b2a89db933d449 560w, https://mintcdn.com/coderabbit/0_UNDuRPehZvImxS/assets/images/plan-editor.png?w=840\u0026fit=max\u0026auto=format\u0026n=0_UNDuRPehZvImxS\u0026q=85\u0026s=ce449bbd480847e02c8c1f92a2858e83 840w, https://mintcdn.com/coderabbit/0_UNDuRPehZvImxS/assets/images/plan-editor.png?w=1100\u0026fit=max\u0026auto=format\u0026n=0_UNDuRPehZvImxS\u0026q=85\u0026s=4a781b18895a37c484c0ee9512976c1b 1100w, https://mintcdn.com/coderabbit/0_UNDuRPehZvImxS/assets/images/plan-editor.png?w=1650\u0026fit=max\u0026auto=format\u0026n=0_UNDuRPehZvImxS\u0026q=85\u0026s=d04ae1c2d1b540e489a43837f16fe107 1650w, https://mintcdn.com/coderabbit/0_UNDuRPehZvImxS/assets/images/plan-editor.png?w=2500\u0026fit=max\u0026auto=format\u0026n=0_UNDuRPehZvImxS\u0026q=85\u0026s=a3d9f2e06617cb10a8c860fa0e1340f9 2500w`})})]}),_jsxs(Tab,{title:`Issue Trackers (GitHub \u0026 GitLab)`,id:`issue-trackers-github-%26-gitlab`,children:[_jsx(_components.p,{children:`The full Coding Plan is posted as a comment directly on the issue. Reply to\nthe plan comment to refine details, challenge design choices, or request\nchanges.`}),_jsx(Frame,{caption:`Coding Plan posted as a comment on a GitHub issue`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/coderabbit/0_UNDuRPehZvImxS/assets/images/planning-github-comment.png?fit=max\u0026auto=format\u0026n=0_UNDuRPehZvImxS\u0026q=85\u0026s=720c50d5d557a1e5bc8838b37d0645f9`,alt:`Coding Plan posted as a comment on a GitHub issue`,\"data-og-width\":`1856`,width:`1856`,\"data-og-height\":`1162`,height:`1162`,\"data-path\":`assets/images/planning-github-comment.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/coderabbit/0_UNDuRPehZvImxS/assets/images/planning-github-comment.png?w=280\u0026fit=max\u0026auto=format\u0026n=0_UNDuRPehZvImxS\u0026q=85\u0026s=2b63e7ec0fbcf1ab2942eee0f0e26d7d 280w, https://mintcdn.com/coderabbit/0_UNDuRPehZvImxS/assets/images/planning-github-comment.png?w=560\u0026fit=max\u0026auto=format\u0026n=0_UNDuRPehZvImxS\u0026q=85\u0026s=704de913d52eb9828f2f7d45765f1d68 560w, https://mintcdn.com/coderabbit/0_UNDuRPehZvImxS/assets/images/planning-github-comment.png?w=840\u0026fit=max\u0026auto=format\u0026n=0_UNDuRPehZvImxS\u0026q=85\u0026s=18079aaf5d574ebd469b08ff446d3652 840w, https://mintcdn.com/coderabbit/0_UNDuRPehZvImxS/assets/images/planning-github-comment.png?w=1100\u0026fit=max\u0026auto=format\u0026n=0_UNDuRPehZvImxS\u0026q=85\u0026s=2d57e486336f5f8a6a688aed8f9bb618 1100w, https://mintcdn.com/coderabbit/0_UNDuRPehZvImxS/assets/images/planning-github-comment.png?w=1650\u0026fit=max\u0026auto=format\u0026n=0_UNDuRPehZvImxS\u0026q=85\u0026s=a4cfe61ace8f771272e362ed759c07bd 1650w, https://mintcdn.com/coderabbit/0_UNDuRPehZvImxS/assets/images/planning-github-comment.png?w=2500\u0026fit=max\u0026auto=format\u0026n=0_UNDuRPehZvImxS\u0026q=85\u0026s=fcc46a3401a814127b9f73cb1cf05ca5 2500w`})})]})]}),`\n`,_jsx(`br`,{}),`\n`,_jsx(Card,{title:`Collaborative Planning`,icon:`users`,horizontal:true,children:_jsx(_components.p,{children:`Plans are available for review by engineers and product owners. Team members discuss, challenge design choices, and refine plans together.`})}),`\n`,_jsx(Card,{title:`Accountability and history`,icon:`clipboard-clock`,horizontal:true,children:_jsx(_components.p,{children:`Every plan version is preserved. Track what was planned, when it was planned, and why decisions were made.`})}),`\n`,_jsx(Heading,{level:`2`,id:`3-handoff`,children:`3. Handoff`}),`\n`,_jsx(_components.p,{children:`Once the plan reflects the team’s decisions, hand off the finalized prompts to your coding agent of choice. The agent receives precise, codebase-aware instructions it can act on immediately.`}),`\n`,_jsx(Card,{title:`Agent-ready prompts`,icon:`zap`,horizontal:true,children:_jsx(_components.p,{children:`Finalized plans are exported as structured, codebase-aware prompts that any coding agent can act on immediately — no reinterpretation required.`})}),`\n`,_jsx(Card,{title:`Any coding agent`,icon:`bot`,horizontal:true,children:_jsx(_components.p,{children:`Hand off to Claude Code, Codex, Cursor, Gemini, or any other coding agent. The prompt format is agent-agnostic.`})}),`\n`,_jsx(Heading,{level:`2`,id:`what’s-next`,children:`What’s next`}),`\n`,_jsxs(CardGroup,{cols:1,children:[_jsx(Card,{title:`CodeRabbit Plan documentation`,icon:`book`,href:`/plan`,horizontal:true,children:_jsx(_components.p,{children:`Full documentation covering the web interface, plan structure, refinement, and Agent Handoff.`})}),_jsx(Card,{title:`Issue-based planning`,icon:`ticket`,href:`/issues/planner`,horizontal:true,children:_jsx(_components.p,{children:`Platform-specific guides for generating Coding Plans from GitHub, GitLab, Azure DevOps, Jira, and Linear issues.`})}),_jsx(Card,{title:`CodeRabbit Agent for Slack`,icon:`slack`,href:`/overview/slack-agent`,horizontal:true,children:_jsx(_components.p,{children:`Bring AI-powered investigation, planning, and code editing into your Slack workspace.`})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{Hint,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"CodeRabbit Plan","sidebarTitle":"CodeRabbit Plan","description":"Turn ideas, issues, PRDs, and designs into precise Coding Plans grounded in your codebase, then hand them off to any coding agent.","mode":"wide","href":"/overview/coderabbit-plan"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[140,3825,")=>null;function _cr"]]},"mdxExtracts":{"tableOfContents":[{"title":"1. Create a plan","slug":"1-create-a-plan","depth":2,"children":[]},{"title":"2. Refine","slug":"2-refine","depth":2,"children":[]},{"title":"3. Handoff","slug":"3-handoff","depth":2,"children":[]},{"title":"What’s next","slug":"what’s-next","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/coderabbit/c83587702ff75216/inkeep.js","/_mintlify/custom/coderabbit/b7ecafa4358af1c7/yaml-editor.js","/_mintlify/custom/coderabbit/44fd990531d7b83e/acquisition.js"],"subdomain":"coderabbit","siteName":"CodeRabbit","title":"CodeRabbit Plan - CodeRabbit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-14T17:21:25.312Z","originalFileLocation":"overview/coderabbit-plan.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Turn ideas, issues, PRDs, and designs into precise Coding Plans grounded in your codebase, then hand them off to any coding agent.\">\u003cmeta data-mint-head name=\"application-name\" content=\"CodeRabbit\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"CodeRabbit Plan - CodeRabbit\">\u003cmeta data-mint-head property=\"og:description\" content=\"Turn ideas, issues, PRDs, and designs into precise Coding Plans grounded in your codebase, then hand them off to any coding agent.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"CodeRabbit Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.coderabbit.ai/overview/coderabbit-plan\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://coderabbit.mintlify.app/_mintlify/api/og/v2?division=Platform+Tour\u0026amp;title=CodeRabbit+Plan\u0026amp;description=Turn+ideas%2C+issues%2C+PRDs%2C+and+designs+into+precise+Coding+Plans+grounded+in+your+codebase%2C+then+hand+them+off+to+any+coding+agent.\u0026amp;theme=eb8011b6d836a1ac186d66ac\u0026amp;signature=6495932836e81ae3ea4419a5317f986dde0cb6d535620b85579f871147c29ea6\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"CodeRabbit Plan - CodeRabbit\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Turn ideas, issues, PRDs, and designs into precise Coding Plans grounded in your codebase, then hand them off to any coding agent.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://coderabbit.mintlify.app/_mintlify/api/og/v2?division=Platform+Tour\u0026amp;title=CodeRabbit+Plan\u0026amp;description=Turn+ideas%2C+issues%2C+PRDs%2C+and+designs+into+precise+Coding+Plans+grounded+in+your+codebase%2C+then+hand+them+off+to+any+coding+agent.\u0026amp;theme=eb8011b6d836a1ac186d66ac\u0026amp;signature=6495932836e81ae3ea4419a5317f986dde0cb6d535620b85579f871147c29ea6\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"CodeRabbit\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF570A\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.coderabbit.ai/overview/coderabbit-plan\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/overview/coderabbit-plan.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.coderabbit.ai/#organization\",\"name\":\"CodeRabbit\",\"url\":\"https://docs.coderabbit.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/coderabbit/qAZa_d7FrwPO_w-O/coderabbit-logo-light.svg?fit=max\u0026auto=format\u0026n=qAZa_d7FrwPO_w-O\u0026q=85\u0026s=d2bf9e91be0e760ec9cb468676fa6ab6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.coderabbit.ai#website\",\"name\":\"CodeRabbit\",\"url\":\"https://docs.coderabbit.ai\",\"publisher\":{\"@id\":\"https://docs.coderabbit.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.coderabbit.ai/overview/coderabbit-plan#webpage\",\"url\":\"https://docs.coderabbit.ai/overview/coderabbit-plan\",\"name\":\"CodeRabbit Plan\",\"description\":\"Turn ideas, issues, PRDs, and designs into precise Coding Plans grounded in your codebase, then hand them off to any coding agent.\",\"dateModified\":\"2026-10-14T17:21:25.312Z\",\"isPartOf\":{\"@id\":\"https://docs.coderabbit.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.coderabbit.ai/overview/coderabbit-plan#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.coderabbit.ai/overview/coderabbit-plan#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Platform\",\"item\":\"https://docs.coderabbit.ai/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Platform Tour\",\"item\":\"https://docs.coderabbit.ai/overview/pull-request-review\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"CodeRabbit Plan\",\"item\":\"https://docs.coderabbit.ai/overview/coderabbit-plan\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.coderabbit.ai/overview/coderabbit-plan#article\",\"headline\":\"CodeRabbit Plan\",\"name\":\"CodeRabbit Plan\",\"description\":\"Turn ideas, issues, PRDs, and designs into precise Coding Plans grounded in your codebase, then hand them off to any coding agent.\",\"url\":\"https://docs.coderabbit.ai/overview/coderabbit-plan\",\"mainEntityOfPage\":{\"@id\":\"https://docs.coderabbit.ai/overview/coderabbit-plan#webpage\"},\"dateModified\":\"2026-10-14T17:21:25.312Z\",\"publisher\":{\"@id\":\"https://docs.coderabbit.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.coderabbit.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"CodeRabbit\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"CodeRabbit","nav":{"global":{"anchors":[{"anchor":"Quickstart","icon":"rocket","hidden":false,"href":"/getting-started/quickstart"},{"anchor":"Blog","icon":"pen-line","hidden":true,"href":"https://coderabbit.ai/blog"},{"anchor":"Changelog","icon":"history","href":"/changelog"},{"anchor":"Support","icon":"life-buoy","href":"/support"},{"anchor":"Discord","icon":"discord","href":"https://discord.gg/coderabbit"}]},"tabs":[{"tab":"CodeRabbit Platform","icon":"layers","groups":[{"group":"Platform","icon":"layers","pages":[{"title":"Agentic Change Management","sidebarTitle":"Overview","mode":"wide","href":""},{"title":"The System Behind Every Review Comment","sidebarTitle":"Architecture","mode":"wide","href":"/overview/architecture"},{"group":"Platform Tour","expanded":false,"pages":[{"title":"Pull Request Reviews","mode":"wide","href":"/overview/pull-request-review"},{"title":"Code reviews in IDE and CLI","sidebarTitle":"IDE and CLI reviews","description":"Review your code in IDE or CLI before pushing it to the repo","mode":"wide","href":"/overview/ide-cli-review"},{"title":"CodeRabbit Plan","sidebarTitle":"CodeRabbit Plan","mode":"wide","href":"/overview/coderabbit-plan"},{"title":"CodeRabbit Agent for Slack","sidebarTitle":"Agent for Slack","description":"Bring AI-powered investigation, planning, and code editing into your Slack workspace: with shared context, persistent knowledge, and governed access.","mode":"wide","href":"/overview/slack-agent"}]}]},{"group":"Getting Started","icon":"rocket","pages":[{"title":"Quickstart","sidebarTitle":"Quickstart","href":"/getting-started/quickstart"},{"group":"Hands-on Guide","root":{"title":"Hands-on guide","href":"/guide/index"},"expanded":false,"pages":[{"title":"Repository setup","sidebarTitle":"Add repository","href":"/guide/repository"},{"title":"Code Review","sidebarTitle":"Code Review","href":"/guide/code-review"},{"title":"Interactive code review chat","sidebarTitle":"Chat","href":"/guide/chat"},{"title":"Improvements","sidebarTitle":"Improvements","href":"/guide/improvements"},{"title":"You're Ready to Ship Better Code!","sidebarTitle":"Success","href":"/guide/complete"}]}]},{"group":"Triage","icon":"list-filter","pages":[{"title":"Triage","sidebarTitle":"Triage overview","href":"/triage/index"},{"title":"Your Triage view","sidebarTitle":"Your Triage view","href":"/triage/your-triage-view"},{"title":"How Triage prioritizes","sidebarTitle":"Prioritization","href":"/triage/prioritization"},{"title":"Actions on a pull request","sidebarTitle":"Actions","href":"/triage/actions"},{"title":"Triage settings","sidebarTitle":"Rules and automation","href":"/triage/rules"},{"title":"Triage in Slack","sidebarTitle":"Triage in Slack","href":"/triage/slack"},{"title":"Requirements and FAQ","sidebarTitle":"Requirements and FAQ","href":"/triage/faq"},{"title":"Troubleshooting Triage","sidebarTitle":"Troubleshooting","href":"/triage/troubleshooting"}]},{"group":"Pull Request Reviews","icon":"git-pull-request","pages":[{"title":"Overview","href":"/guides/code-review-overview"},{"title":"PR Summaries","href":"/pr-reviews/summaries"},{"title":"PR Walkthroughs","href":"/pr-reviews/walkthroughs"},{"title":"Merge Risk","sidebarTitle":"Merge Risk","href":"/pr-reviews/merge-risk"},{"title":"CI/CD Pipeline Analysis","href":"/pr-reviews/cicd-pipeline-analysis"},{"title":"PR validation using linked issues","sidebarTitle":"Linked Issues","href":"/issues/pr-validation"},{"title":"Slop Detection","sidebarTitle":"Slop Detection","href":"/pr-reviews/slop-detection"},{"title":"Path-based review instructions","href":"/configuration/path-instructions"},{"title":"AST-based path instructions","href":"/configuration/ast-grep-instructions"},{"title":"Automatic review controls","sidebarTitle":"Automatic review controls","href":"/configuration/auto-review"},{"title":"CodeRabbit status check","sidebarTitle":"Status check","href":"/pr-reviews/status-check"},{"title":"Manage code reviews","href":"/guides/commands"},{"title":"Review commands","sidebarTitle":"Review commands","href":"/reference/review-commands"}]},{"group":"Change Stack","icon":"layers","pages":[{"title":"Change Stack","sidebarTitle":"Change Stack overview","href":"/change-stack/index"},{"title":"Navigate a change","sidebarTitle":"Navigation","href":"/change-stack/navigation"},{"title":"Read changes","href":"/change-stack/reading-diffs"},{"title":"Understand findings","sidebarTitle":"Findings","href":"/change-stack/findings"},{"title":"Review and merge","sidebarTitle":"Review and merge","href":"/change-stack/reviewing"},{"title":"Ask about the change","sidebarTitle":"Chat","href":"/change-stack/chat"},{"title":"Collaborate in Slack and Discord","sidebarTitle":"Slack and Discord collaboration","href":"/change-stack/notifications"},{"title":"Snapshots and freshness","sidebarTitle":"Snapshots","href":"/change-stack/snapshots"},{"title":"Provider support","href":"/change-stack/provider-support"}]},{"group":"Available actions","icon":"message-square-diff","pages":[{"title":"Create issues","sidebarTitle":"Issue creation","href":"/issues/creation"}]},{"group":"Pre-Merge Checks","icon":"shield","pages":[{"title":"Built-in Pre-Merge Checks","sidebarTitle":"Built-in Checks","href":"/pr-reviews/pre-merge-checks"},{"title":"Custom checks","href":"/pr-reviews/custom-checks"}]},{"group":"Approvals","icon":"badge-check","pages":[{"title":"Automatic Approvals","sidebarTitle":"Automatic Approvals","href":"/pr-reviews/automatic-approvals"},{"title":"Approval risk limits","sidebarTitle":"Risk limits","href":"/pr-reviews/approval-risk-limits"},{"title":"Choose an approval policy","sidebarTitle":"Approval policies","href":"/pr-reviews/approval-policies"}]},{"group":"Post-Merge Actions","icon":"rocket","pages":[{"title":"Post-Merge Actions","sidebarTitle":"Post-Merge Actions","href":"/pr-reviews/post-merge-actions"}]},{"group":"Finishing touches","icon":"paintbrush","pages":[{"title":"Finishing Touches overview","sidebarTitle":"Overview","href":"/finishing-touches/index"},{"title":"Fix comments: apply CodeRabbit code fixes to pull requests","sidebarTitle":"Fix comments","href":"/finishing-touches/autofix"},{"title":"Fix CI failures","href":"/finishing-touches/fix-ci"},{"title":"Resolve Merge Conflicts","href":"/finishing-touches/resolve-merge-conflict"},{"title":"Generate unit tests","href":"/finishing-touches/unit-test-generation"},{"title":"Custom Finishing Touch recipes","sidebarTitle":"Custom recipes","href":"/finishing-touches/custom-finishing-touches"},{"title":"Simplify code","href":"/finishing-touches/simplify"},{"title":"Generate docstrings","href":"/finishing-touches/docstrings"}]},{"group":"Knowledge Base","icon":"brain","pages":[{"title":"Knowledge Base overview","sidebarTitle":"Overview","href":"/knowledge-base/index"},{"title":"Learnings","href":"/knowledge-base/learnings"},{"title":"Code Guidelines","href":"/knowledge-base/code-guidelines"},{"title":"Multi-Repo Analysis","href":"/knowledge-base/multi-repo-analysis"},{"title":"Connected knowledge repositories","href":"/knowledge-base/connected-repositories"},{"title":"MCP Servers","href":"/knowledge-base/mcp-context"},{"title":"Web Search","href":"/knowledge-base/web-search"}]},{"group":"CodeRabbit Security","icon":"shield-check","pages":[{"title":"CodeRabbit Security","sidebarTitle":"Security overview","href":"/security/index"},{"title":"CodeRabbit Security check","sidebarTitle":"Pull request check","href":"/security/pull-request-check"},{"title":"Attack surface and continuous posture","sidebarTitle":"Attack surface","href":"/security/attack-surface"},{"title":"Delta scans","href":"/security/delta-scans"},{"title":"Security Blast Radius","sidebarTitle":"Blast Radius","href":"/security/blast-radius"},{"title":"Steer Deep Scans","href":"/security/steer-scans"},{"title":"Runtime verification","href":"/security/runtime-verification"},{"title":"Security Architecture Review","sidebarTitle":"Architecture Review","href":"/security/architecture-review"}]},{"group":"Configuration","icon":"settings","pages":[{"title":"Configuration overview","sidebarTitle":"Configuration overview","href":"/guides/configuration-overview"},{"title":"Configuration inheritance","href":"/configuration/configuration-inheritance"},{"group":"Configuration file","expanded":false,"pages":[{"title":"Configuration via YAML file","href":"/getting-started/yaml-configuration"},{"title":"Configuration via TypeScript file","sidebarTitle":"TypeScript configuration","href":"/configuration/typescript-configuration"},{"title":"Central configuration","href":"/configuration/central-configuration"},{"title":"YAML validator","href":"/configuration/yaml-validator"}]},{"group":"Configuration UI","expanded":false,"pages":[{"title":"Repository settings","href":"/guides/repository-settings"},{"title":"Organization settings","href":"/guides/organization-settings"}]},{"group":"Configuration Examples","root":{"title":"Configuration examples","href":"/configuration/example/index"},"expanded":false,"pages":[{"title":"Sample configuration for React Native + Expo","sidebarTitle":"React Native + Expo","mode":"wide","href":"/configuration/example/typescript/expo"},{"title":"Sample configuration for Django","sidebarTitle":"Python + Django","mode":"wide","href":"/configuration/example/python/django"},{"title":"Sample configuration for Mintlify-based documentation website","sidebarTitle":"Mintlify Documentation","mode":"wide","href":"/configuration/example/other/mintlify-documentation"}]}]},{"group":"Tools","icon":"wrench","expanded":false,"pages":[{"title":"Third-party tools overview","sidebarTitle":"Third-party tools","href":"/tools/index"},{"title":"Tool catalog","href":"/tools/list"},{"group":"Per-tool guides","expanded":false,"pages":[{"group":"Multipurpose","pages":[{"title":"ast-grep","href":"/tools/ast-grep"},{"title":"Semgrep","href":"/tools/semgrep"},{"title":"OpenGrep","href":"/tools/opengrep"}]},{"group":"Security","pages":[{"title":"Betterleaks","href":"/tools/betterleaks"},{"title":"SkillSpector","href":"/tools/skillspector"},{"title":"TruffleHog","href":"/tools/trufflehog"},{"title":"Microsoft Presidio Analyzer","sidebarTitle":"Presidio","href":"/tools/presidio"},{"title":"OSV-Scanner","href":"/tools/osv-scanner"},{"title":"Brakeman","href":"/tools/brakeman"}]},{"group":"Languages","pages":[{"title":"ESLint","href":"/tools/eslint"},{"title":"Biome","href":"/tools/biome"},{"title":"Oxlint","href":"/tools/oxlint"},{"title":"React Doctor","href":"/tools/react-doctor"},{"title":"Ruff","href":"/tools/ruff"},{"title":"Pylint","href":"/tools/pylint"},{"title":"Flake8","href":"/tools/flake8"},{"title":"golangci-lint","href":"/tools/golangci-lint"},{"title":"Clippy","href":"/tools/clippy"},{"title":"RuboCop","href":"/tools/rubocop"},{"title":"SwiftLint","href":"/tools/swiftlint"},{"title":"PHPStan","href":"/tools/phpstan"},{"title":"PHPMD","href":"/tools/phpmd"},{"title":"PHPCS","href":"/tools/phpcs"},{"title":"PMD","href":"/tools/pmd"},{"title":"detekt","href":"/tools/detekt"},{"title":"Clang-Tidy","href":"/tools/clang-tidy"},{"title":"Cppcheck","href":"/tools/cppcheck"},{"title":"Verilator","href":"/tools/verilator"},{"title":"Infer","href":"/tools/fbinfer"},{"title":"Luacheck","href":"/tools/luacheck"},{"title":"ShellCheck","href":"/tools/shellcheck"},{"title":"Blinter","href":"/tools/blinter"},{"title":"Fortitude","href":"/tools/fortitude"},{"title":"Regal","href":"/tools/regal"},{"title":"PSScriptAnalyzer","href":"/tools/psscriptanalyzer"},{"title":"smarty-lint","href":"/tools/smarty-lint"},{"title":"SQLFluff","href":"/tools/sqlfluff"},{"title":"Squawk","href":"/tools/squawk"},{"title":"Prisma Lint","href":"/tools/prisma-lint"},{"title":"Stylelint","href":"/tools/stylelint"},{"title":"HTMLHint","href":"/tools/htmlhint"},{"title":"ember-template-lint","href":"/tools/ember-template-lint"},{"title":"YAMLlint","href":"/tools/yamllint"},{"title":"Dotenv Linter","href":"/tools/dotenv"},{"title":"Buf","href":"/tools/buf"},{"title":"oasdiff","href":"/tools/oasdiff"},{"title":"Checkmake","href":"/tools/checkmake"},{"title":"Shopify Theme Check","href":"/tools/shopify-cli"}]},{"group":"Infrastructure as code","pages":[{"title":"Checkov","href":"/tools/checkov"},{"title":"Trivy","href":"/tools/trivy"},{"title":"TFLint","href":"/tools/tflint"},{"title":"Hadolint","href":"/tools/hadolint"}]},{"group":"CI/CD","pages":[{"title":"actionlint","href":"/tools/actionlint"},{"title":"zizmor","href":"/tools/zizmor"},{"title":"CircleCI","href":"/tools/circleci"},{"title":"GitHub Checks","href":"/tools/github-checks"}]},{"group":"Docs and prose","pages":[{"title":"markdownlint","href":"/tools/markdownlint"},{"title":"LanguageTool","href":"/tools/languagetool"},{"title":"Vale","href":"/tools/vale"}]}]},{"title":"Tools configuration reference","sidebarTitle":"Tools configuration","mode":"wide","href":"/tools/reference"}]},{"group":"CodeRabbit Plan","icon":"list-check","pages":[{"title":"CodeRabbit Plan overview","sidebarTitle":"Overview","href":"/plan/index"},{"title":"Create a plan","sidebarTitle":"Create a plan","href":"/plan/create-plan"},{"title":"Plan structure and refinement","sidebarTitle":"Plan refinement","href":"/plan/plan-refinement"},{"title":"Agent Handoff","sidebarTitle":"Agent Handoff","href":"/plan/agent-handoff"},{"group":"Issue Planner","root":{"title":"Issue Planner","href":"/issues/planner/index"},"expanded":false,"pages":[{"title":"Planning on GitHub","icon":"github","sidebarTitle":"GitHub guide","href":"/issues/planner/github"},{"title":"Planning on GitLab","sidebarTitle":"GitLab guide","icon":"gitlab","href":"/issues/planner/gitlab"},{"title":"Planning on Azure DevOps","sidebarTitle":"Azure DevOps guide","icon":"microsoft","href":"/issues/planner/azure-devops"},{"title":"Planning on Jira","sidebarTitle":"Jira guide","icon":"jira","href":"/issues/planner/jira"},{"title":"Planning on Linear","sidebarTitle":"Linear guide","icon":"linear","href":"/issues/planner/linear"}]}]},{"group":"Issue Management","icon":"clipboard-check","pages":[{"title":"Issue Enrichment","href":"/issues/enrichment"}]},{"group":"Resources","icon":"book-open","pages":[{"title":"Configuration reference","href":"/reference/configuration"},{"title":"CodeRabbit glossary: review, Git, and code analysis terms","sidebarTitle":"Glossary","href":"/reference/glossary"},{"title":"CodeRabbit FAQs: reviews, pricing, security, and setup","sidebarTitle":"CodeRabbit FAQ","href":"/faq"}]}]},{"tab":"CLI and IDE tools","icon":"square-terminal","pages":[{"title":"CLI and IDE tools","href":"/cli"}]},{"tab":"Coding Agent","icon":"square-code","pages":[{"title":"Coding Agent","href":"/code"}]},{"tab":"Agent for Slack and Discord","icon":"bot","pages":[{"title":"Agent for Slack and Discord","href":"/agent"}]},{"tab":"Management","icon":"wrench","pages":[{"title":"Management","href":"/management"}]}]},"basePath":"","title":"CodeRabbit Plan - CodeRabbit","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["10e4515597","07c022d89b","a74be98ba7"],"chunks":["BannerMarkdown-CXEEkV6J.js","dist-lvhuD9Du.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-D1Z-ELXV.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","Frame-Bpq2Z6jK.js","DynamicMarkdown-D5M2At0B.js","zoom-image-lightbox-DL4wrF0w.js","lightbox-handle-r17bVUz3.js"]}
