diff --git a/packages/docs/content/assets/images/execute-plan-mode-026.png b/packages/docs/content/assets/images/execute-plan-mode-026.png new file mode 100644 index 0000000000..295a3eaeb8 Binary files /dev/null and b/packages/docs/content/assets/images/execute-plan-mode-026.png differ diff --git a/packages/docs/content/assets/images/inline-comments-plan-mode-026.png b/packages/docs/content/assets/images/inline-comments-plan-mode-026.png new file mode 100644 index 0000000000..887907fe74 Binary files /dev/null and b/packages/docs/content/assets/images/inline-comments-plan-mode-026.png differ diff --git a/packages/docs/content/assets/images/review-plan-mode-026.png b/packages/docs/content/assets/images/review-plan-mode-026.png new file mode 100644 index 0000000000..3c5e00bf24 Binary files /dev/null and b/packages/docs/content/assets/images/review-plan-mode-026.png differ diff --git a/packages/docs/content/assets/images/select-plan-mode-026.png b/packages/docs/content/assets/images/select-plan-mode-026.png new file mode 100644 index 0000000000..457be871ad Binary files /dev/null and b/packages/docs/content/assets/images/select-plan-mode-026.png differ diff --git a/packages/docs/content/assets/images/submit-reviews-plan-mode-026.png b/packages/docs/content/assets/images/submit-reviews-plan-mode-026.png new file mode 100644 index 0000000000..6a451866f4 Binary files /dev/null and b/packages/docs/content/assets/images/submit-reviews-plan-mode-026.png differ diff --git a/packages/docs/content/docs/create-plan.mdx b/packages/docs/content/docs/create-plan.mdx new file mode 100644 index 0000000000..1d49d0ef71 --- /dev/null +++ b/packages/docs/content/docs/create-plan.mdx @@ -0,0 +1,80 @@ +--- +title: Create Plan +description: Plan, review, and align before executing code changes. +icon: "NotebookPen" +--- + +# Create Plan Mode + +Create Plan mode lets you generate and refine an implementation plan before Pochi makes any code changes. + +Instead of immediately editing files, the agent explores your workspace and produces a structured plan as a workspace file (`plan.md`). You can review the plan, leave inline comments, refine assumptions, and only start execution once you’re aligned on the approach. + + + +## When to Use Create Plan + +Create Plan is especially helpful for refactors or large feature work and even for tasks involving new dependencies or migrations. This is because changes like these can affect multiple parts of the systems and it’ll be wise if you review scope and risks first. + +For small, obvious changes, you can still use normal tasks that go straight to execution. + + +## How to Use Create Plan + +### 1. Create a Plan Task +Open the task sidebar and describe what you want to build or change. Instead of normal execution mode click on “Plan” button when hovering over the send icon. + +![Plan Mode](../assets/images/select-plan-mode-026.png) + + +Pochi will create a new task, refine you prompt based on your existing codebase, and generate a plan. + + +### 2. Review the Plan +Next, you can click on the “Review” button to open the plan as a workspace file (`plan.md`). + +![Review Plan](../assets/images/review-plan-mode-026.png) + +You can read through the proposed steps and assumptions, leave inline comments on specific parts of the plan and edit the text directly if you want to refine wording or scope. + +![Inline Comments](../assets/images/inline-comments-plan-mode-026.png) + + +### 3. Refine and Iterate + +After commenting or editing you can ask Pochi to update or refine the plan. It will revise the plan based on your feedback. + +![Submit reviews as refining plan](../assets/images/submit-reviews-plan-mode-026.png) + +You can repeat this until you’re satisfied with the approach. + + +### 4. Start Execution +When the plan looks good, proceed to click on “Execute” in the task panel. Pochi will begin implementing the plan and applying code changes. + +![Execute plan](../assets/images/execute-plan-mode-026.png) + +From this point, the task behaves like a normal execution task, and you can continue reviewing code with diffs and inline comments. + + + +## Notes +* Create Plan does not modify code until execution is explicitly started. +* Large plans may take longer to generate due to workspace exploration. +* The quality of the plan depends on how clearly the goal is described. + +## Best Practices + +It’s great to use Create Plan for tasks where scope or approach is unclear. As the plan progresses, be explicit in comments when you want to change direction or constraints. + +Ideally treat the plan like a design review: focusing on risks, edge cases and sequencing. Once execution starts, you can continue using reviews to guide further iterations. diff --git a/packages/docs/content/docs/meta.json b/packages/docs/content/docs/meta.json index 35cc03afd4..415c062d68 100644 --- a/packages/docs/content/docs/meta.json +++ b/packages/docs/content/docs/meta.json @@ -15,6 +15,7 @@ "tab-completion", "reviews", "edits", + "create-plan", "auto-compact", "checkpoint", "permissions",