> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CodeRabbit Plan

> Turn ideas, issues, PRDs, and designs into precise Coding Plans grounded in your codebase, then hand them off to any coding agent.

export const Hint = ({type, children, headline, tip, href, cta}) => {
  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 (Autofix, 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"
    },
    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"
    }
  };
  const defaults = TIPS[type] || ({});
  return <Tooltip headline={headline ?? defaults.headline} tip={tip ?? defaults.tip} cta={cta ?? defaults.cta} href={href ?? defaults.href}>
      {children ?? defaults.content}
    </Tooltip>;
};

[CodeRabbit Plan](/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](/overview/architecture) and enriched by your project [Knowledge Base](/knowledge-base), it references the right files, follows your established patterns, and produces agent-ready prompts, not generic outlines.

## 1. Create a plan

<Tabs>
  <Tab title="Using web interface">
    The fastest way to get started is the CodeRabbit web app. Go to [app.coderabbit.ai/plan](https://app.coderabbit.ai/plan/new), describe what you want to build in a free-form text, select a repository, and click **Create plan**. The form also supports file attachments.

    See the [Create a plan guide](/plan/create-plan) for the full step-by-step walkthrough.
  </Tab>

  <Tab title="Using issue tracker">
    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.

    <CardGroup cols={4}>
      <Card title="GitHub" icon="github" href="/issues/planner/github" horizontal />

      <Card title="GitLab" icon="gitlab" href="/issues/planner/gitlab" horizontal />

      <Card title="Jira" icon="jira" href="/issues/planner/jira" horizontal />

      <Card title="Linear" icon="linear" href="/issues/planner/linear" horizontal />
    </CardGroup>
  </Tab>
</Tabs>

<br />

<CardGroup cols={1}>
  <Card title="Codebase understanding" icon="code-xml" horizontal>
    Analyzes your repository's architecture, patterns, and existing code so
    every plan fits naturally into how your project is built.
  </Card>

  <Card title="Project context" icon="database" horizontal>
    Draws on related issues, design documents, and accumulated <Hint type="learnings">learnings</Hint> to
    ground every plan in your project's broader context.
  </Card>
</CardGroup>

## 2. Refine

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.

<Tabs>
  <Tab title="Web app">
    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.

    <Frame caption="Coding Plan in the CodeRabbit web app">
      <img src="https://mintcdn.com/coderabbit/0_UNDuRPehZvImxS/assets/images/plan-editor.png?fit=max&auto=format&n=0_UNDuRPehZvImxS&q=85&s=675d1c116a50b922932579684cb300c3" alt="Coding Plan in the CodeRabbit web app" width="2918" height="1596" data-path="assets/images/plan-editor.png" />
    </Frame>
  </Tab>

  <Tab title="Issue Trackers (GitHub & GitLab)">
    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.

    <Frame caption="Coding Plan posted as a comment on a GitHub issue">
      <img src="https://mintcdn.com/coderabbit/0_UNDuRPehZvImxS/assets/images/planning-github-comment.png?fit=max&auto=format&n=0_UNDuRPehZvImxS&q=85&s=720c50d5d557a1e5bc8838b37d0645f9" alt="Coding Plan posted as a comment on a GitHub issue" width="1856" height="1162" data-path="assets/images/planning-github-comment.png" />
    </Frame>
  </Tab>
</Tabs>

<br />

<Card title="Collaborative Planning" icon="users" horizontal>
  Plans are available for review by engineers and product owners. Team members discuss, challenge design choices, and refine plans together.
</Card>

<Card title="Accountability and history" icon="clipboard-clock" horizontal>
  Every plan version is preserved. Track what was planned, when it was planned, and why decisions were made.
</Card>

## 3. Handoff

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.

<Card title="Agent-ready prompts" icon="zap" horizontal>
  Finalized plans are exported as structured, codebase-aware prompts that any coding agent can act on immediately — no reinterpretation required.
</Card>

<Card title="Any coding agent" icon="bot" horizontal>
  Hand off to Claude Code, Codex, Cursor, Gemini, or any other coding agent. The prompt format is agent-agnostic.
</Card>

## What's next

<CardGroup cols={1}>
  <Card title="CodeRabbit Plan documentation" icon="book" href="/plan" horizontal>
    Full documentation covering the web interface, plan structure, refinement, and Agent Handoff.
  </Card>

  <Card title="Issue-based planning" icon="ticket" href="/issues/planner" horizontal>
    Platform-specific guides for generating Coding Plans from GitHub, GitLab, Jira, and Linear issues.
  </Card>

  <Card title="CodeRabbit Agent for Slack" icon="slack" href="/overview/slack-agent" horizontal>
    Bring AI-powered investigation, planning, and code editing into your Slack workspace.
  </Card>
</CardGroup>
