Merge pull request #630 from codeflash-ai/chore/add-staging/docs

docs: add staging documentation

Author: HeshamHM28

docs/docs.json

@@ -10,7 +10,7 @@
   "favicon": "/favicon.ico",
   "integrations": {
     "intercom": {
-          "appId": "ljxo1nzr"
+      "appId": "ljxo1nzr"
     }
   },
   "navigation": {
@@ -20,16 +20,14 @@
         "groups": [
           {
             "group": "🏠 Overview",
-            "pages": [
-              "index"
-            ]
+            "pages": ["index"]
           },
           {
+
             "group": "🚀 Quickstart",
             "pages": [
               "getting-started/local-installation"
-            ]
-          },
+            ]          },
           {
             "group": "⚡ Optimizing with Codeflash",
             "pages": [
@@ -42,22 +40,17 @@
             "group": "✨ Continuous Optimization",
             "pages": [
               "optimizing-with-codeflash/codeflash-github-actions",
-              "optimizing-with-codeflash/benchmarking"
+              "optimizing-with-codeflash/benchmarking",
+               "optimizing-with-codeflash/review-optimizations"
             ]
           },
           {
             "group": "🧠 Core Concepts",
-            "pages": [
-              "codeflash-concepts/how-codeflash-works",
-              "codeflash-concepts/benchmarking"
-            ]
+            "pages": ["codeflash-concepts/how-codeflash-works", "codeflash-concepts/benchmarking"]
           },
           {
             "group": "⚙️ Configuration & Best Practices",
-            "pages": [
-              "configuration",
-              "getting-the-best-out-of-codeflash"
-            ]
+            "pages": ["configuration", "getting-the-best-out-of-codeflash"]
           }
         ]
       }
@@ -91,9 +84,7 @@
     }
   },
   "contextual": {
-    "options": [
-      "copy"
-    ]
+    "options": ["copy"]
   },
   "redirects": [
     {
@@ -116,11 +107,11 @@
             "href": "https://www.codeflash.ai/privacy-policy"
           },
           {
-            "label": "Terms of Service", 
+            "label": "Terms of Service",
             "href": "https://www.codeflash.ai/terms-of-service"
           }
         ]
       }
     ]
   }
-}
+}

docs/images/edited-code.png

@@ -0,0 +1,61 @@
+---
+title: "Staging Review for Optimizations"
+description: "Review and manage optimizations before creating pull requests with staging mode"
+icon: "layer-group"
+sidebarTitle: "Review Optimizations"
+keywords:
+  [
+    "staging review",
+    "optimization preview",
+    "pro feature",
+    "batch review",
+    "pull request management",
+  ]
+---
+
+# Staging Review for Optimizations
+
+<Note>
+  This is a Pro feature available exclusively to Codeflash Pro users. [Upgrade to
+  Pro](https://app.codeflash.ai/billing) to access it.
+</Note>
+Staging Review allows you to preview and evaluate all optimizations before creating pull requests. This
+feature provides a centralized review interface where you can examine proposed changes and selectively
+create pull requests for approved optimizations.
+
+## Benefits of Staging Review
+
+- **Preview without PRs:** Review all optimization suggestions without cluttering your repository with multiple pull requests
+- **Batch review:** Examine all optimizations in one centralized location
+- **Selective PR creation:** Choose which optimizations to convert into pull requests
+- **Reduced noise:** Keep your repository's PR list clean while evaluating changes
+
+## Using Staging Review
+
+To optimize your codebase with staging review enabled, run:
+
+```bash
+codeflash --all --staging-review
+```
+
+This command will:
+
+
+1. Start to optimize your project, and if it finds any optimizations, it will save them to [Review Optimizations Page](https://app.codeflash.ai/review-optimizations) instead of creating PRs immediately
+
+   ![Review Optimizations List](../images/review-optimizations.png)
+
+2. Provide you with a staging interface to review all proposed changes
+
+   ![Staging Review Editor](../images/editor.png)
+
+## Managing Staged Optimizations
+
+Once optimizations are staged, you can:
+- Review each optimization individually
+- Compare original and optimized code side-by-side
+- Edit the code of staged optimizations 
+- Create pull requests for selected optimizations directly from the staging interface
+
+![Edited Code](../images/edited-code.png)
+