Merge pull request #602 from codeflash-ai/docs

migrate docs to mintlify

Author: misrasaurabh1

.github/workflows/deploy-docs-to-azure.yaml

@@ -1,5 +1,9 @@
 ---
-sidebar_position: 2
+title: "How Codeflash Measures Code Runtime"
+description: "Learn how Codeflash accurately measures code performance using multiple runs and minimum timing"
+icon: "stopwatch"
+sidebarTitle: "Runtime Measurement"
+keywords: ["benchmarking", "performance", "timing", "measurement", "runtime", "noise reduction"]
 ---
 
 # How Codeflash measures code runtime
@@ -70,7 +74,7 @@ You ask the driver to repeat the race multiple times. In this scenario, since th
 
 This gives us timing data (in hours) that looks like the following.
 
-![img_2.png](img_2.png)
+![img_2.png](./img_2.png)
 
 With 100 data points (50 per train), determining the faster train becomes more complex.
 
@@ -120,7 +124,7 @@ We can only measure times between adjacent stations.
 
 Here is how the timing data looks like (in hours):
 
-![img_1.png](img_1.png)
+![img_1.png](./img_1.png)
 
 With 300 data points (50 runs × 3 segments × 2 trains) and varying conditions on each segment, 
 determining the faster train becomes even more challenging.

docs/.gitignore

@@ -1,5 +1,9 @@
 ---
-sidebar_position: 1
+title: "How Codeflash Works"
+description: "Understand Codeflash's generate-and-verify approach to code optimization and correctness verification"
+icon: "gear"
+sidebarTitle: "How It Works"
+keywords: ["architecture", "verification", "correctness", "testing", "optimization", "LLM", "benchmarking"]
 ---
 # How Codeflash Works
 
@@ -24,7 +28,7 @@ Codeflash currently only runs tests that directly call the target function in th
 To optimize code, Codeflash first gathers all necessary context from the codebase. It also line-profiles your code to understand where the bottlenecks might reside. It then calls our backend to generate several candidate optimizations. These are called "candidates" because their speed and correctness haven't been verified yet. Both properties will be verified in later steps.
 ## Verification of correctness
 
-![Verification](/img/codeflash_arch_diagram.gif)
+![Verification](/images/codeflash_arch_diagram.gif)
 
 The goal of correctness verification is to ensure that when the new code replaces the original code, there are no behavioral changes in the code and the rest of the system. This means the replacement should be completely safe.
 

docs/README.md

@@ -1,5 +1,9 @@
 ---
-sidebar_position: 5
+title: "Manual Configuration"
+description: "Configure Codeflash for your project with pyproject.toml settings and advanced options"
+icon: "gear"
+sidebarTitle: "Configuration"
+keywords: ["configuration", "pyproject.toml", "setup", "settings", "pytest", "formatter"]
 ---
 
 # Manual Configuration

docs/babel.config.js

@@ -0,0 +1,115 @@
+{
+  "$schema": "https://mintlify.com/docs.json",
+  "theme": "aspen",
+  "name": "Codeflash Documentation",
+  "colors": {
+    "primary": "#2563EB",
+    "light": "#3B82F6",
+    "dark": "#1D4ED8"
+  },
+  "favicon": "/favicon.ico",
+  "navigation": {
+    "tabs": [
+      {
+        "tab": "Documentation",
+        "groups": [
+          {
+            "group": "🏠 Overview",
+            "pages": [
+              "index"
+            ]
+          },
+          {
+            "group": "🚀 Getting Started",
+            "pages": [
+              "getting-started/local-installation"
+            ]
+          },
+          {
+            "group": "🔧 CI/CD Integration",
+            "pages": [
+              "getting-started/codeflash-github-actions",
+              "optimizing-with-codeflash/optimize-prs",
+              "optimizing-with-codeflash/benchmarking"
+            ]
+          },
+          {
+            "group": "⚡ Optimization Workflows",
+            "pages": [
+              "optimizing-with-codeflash/one-function",
+              "optimizing-with-codeflash/trace-and-optimize",
+              "optimizing-with-codeflash/codeflash-all"
+            ]
+          },
+          {
+            "group": "🧠 Core Concepts",
+            "pages": [
+              "codeflash-concepts/how-codeflash-works",
+              "codeflash-concepts/benchmarking"
+            ]
+          },
+          {
+            "group": "⚙️ Configuration & Best Practices",
+            "pages": [
+              "configuration",
+              "getting-the-best-out-of-codeflash"
+            ]
+          }
+        ]
+      }
+    ],
+    "global": {
+      "anchors": [
+        {
+          "anchor": "GitHub",
+          "href": "https://github.com/codeflash-ai",
+          "icon": "github"
+        },
+        {
+          "anchor": "Discord",
+          "href": "https://www.codeflash.ai/discord",
+          "icon": "discord"
+        }
+      ]
+    }
+  },
+  "logo": {
+    "light": "/images/codeflash_light.svg",
+    "dark": "/images/codeflash_darkmode.svg"
+  },
+  "navbar": {
+    "links": [
+      {
+        "label": "Contact",
+        "href": "mailto:[email protected]"
+      },
+      {
+        "label": "Blog",
+        "href": "https://www.codeflash.ai/blog"
+      }
+    ],
+    "primary": {
+      "type": "button",
+      "label": "Try Codeflash",
+      "href": "https://www.codeflash.ai"
+    }
+  },
+  "contextual": {
+    "options": [
+      "copy"
+    ]
+  },
+  "redirects": [
+    {
+      "source": "/docs/:path*",
+      "destination": "/:path*"
+    }
+  ],
+  "footer": {
+    "socials": {
+      "discord": "https://www.codeflash.ai/discord",
+      "github": "https://github.com/codeflash-ai",
+      "linkedin": "https://www.linkedin.com/company/codeflash-ai"
+    }
+  }
+}